src/Object/Api/Mastodon/Notification.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Object\Api\Mastodon;
  23
  24 use Friendica\BaseDataTransferObject;
  25 use Friendica\Util\DateTimeFormat;
  26
  27 /**
  28  * Class Notification
  29  *
  30  * @see https://docs.joinmastodon.org/entities/notification/
  31  */
  32 class Notification extends BaseDataTransferObject
  33 {
  34         /** @var string */
  35         protected $id;
  36         /** @var string (Enumerable oneOf) */
  37         protected $type;
  38         /** @var string (Datetime) */
  39         protected $created_at;
  40         /** @var Account */
  41         protected $account;
  42         /** @var Status|null */
  43         protected $status = null;
  44
  45         /**
  46          * Creates a notification record
  47          *
  48          * @param array   $item
  49          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  50          */
  51         public function __construct(int $id, string $type, string $created_at, Account $account = null, Status $status = null)
  52         {
  53                 $this->id         = (string)$id;
  54                 $this->type       = $type;
  55                 $this->created_at = DateTimeFormat::utc($created_at, DateTimeFormat::JSON);
  56                 $this->account    = $account->toArray();
  57
  58                 if (!empty($status)) {
  59                         $this->status = $status->toArray();
  60                 }
  61         }
  62
  63         /**
  64          * Returns the current entity as an array
  65          *
  66          * @return array
  67          */
  68         public function toArray(): array
  69         {
  70                 $notification = parent::toArray();
  71
  72                 if (!$notification['status']) {
  73                         unset($notification['status']);
  74                 }
  75
  76                 return $notification;
  77         }
  78 }