src/Object/Api/Mastodon/Attachment.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
  26 /**
  27  * Class Attachment
  28  *
  29  * @see https://docs.joinmastodon.org/entities/attachment
  30  */
  31 class Attachment extends BaseDataTransferObject
  32 {
  33         /** @var string */
  34         protected $id;
  35         /** @var string */
  36         protected $type;
  37         /** @var string */
  38         protected $url;
  39         /** @var string */
  40         protected $preview_url;
  41         /** @var string */
  42         protected $remote_url;
  43         /** @var string */
  44         protected $text_url;
  45         /** @var string */
  46         protected $description;
  47
  48         /**
  49          * Creates an attachment
  50          *
  51          * @param array $attachment
  52          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  53          */
  54         public function __construct(array $attachment, string $type, string $url, string $preview, string $remote)
  55         {
  56                 $this->id = (string)$attachment['id'];
  57                 $this->type = $type;
  58                 $this->url = $url;
  59                 $this->preview_url = $preview;
  60                 $this->remote_url = $remote;
  61                 $this->text_url = $this->remote_url ?? $this->url;
  62                 $this->description = $attachment['description'];
  63         }
  64
  65         /**
  66          * Returns the current entity as an array
  67          *
  68          * @return array
  69          */
  70         public function toArray(): array
  71         {
  72                 $attachment = parent::toArray();
  73
  74                 if (empty($attachment['remote_url'])) {
  75                         $attachment['remote_url'] = null;
  76                 }
  77
  78                 return $attachment;
  79         }
  80 }