src/Object/Api/Mastodon/Card.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2020, Friendica
   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 Card
  28  *
  29  * @see https://docs.joinmastodon.org/entities/card
  30  */
  31 class Card extends BaseDataTransferObject
  32 {
  33         /** @var string */
  34         protected $url;
  35         /** @var string */
  36         protected $title;
  37         /** @var string */
  38         protected $description;
  39         /** @var string */
  40         protected $type;
  41         /** @var string */
  42         protected $provider_name;
  43         /** @var string */
  44         protected $provider_url;
  45         /** @var string */
  46         protected $image;
  47
  48         /**
  49          * Creates a card record from an attachment array.
  50          *
  51          * @param array   $attachment Attachment record
  52          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  53          */
  54         public function __construct(array $attachment)
  55         {
  56                 $this->url           = $attachment['url'] ?? '';
  57                 $this->title         = $attachment['title'] ?? '';
  58                 $this->description   = $attachment['description'] ?? '';
  59                 $this->type          = $attachment['type'] ?? '';
  60                 $this->image         = $attachment['image'] ?? '';
  61                 $this->provider_name = $attachment['provider_name'] ?? '';
  62                 $this->provider_url  = $attachment['provider_url'] ?? '';
  63         }
  64
  65         /**
  66          * Returns the current entity as an array
  67          *
  68          * @return array
  69          */
  70         public function toArray(): array
  71         {
  72                 if (empty($this->url)) {
  73                         return [];
  74                 }
  75
  76                 return parent::toArray();
  77         }
  78 }