src/Object/Api/Mastodon/Card.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 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 $author_name;
  43         /** @var string */
  44         protected $author_url;
  45         /** @var string */
  46         protected $provider_name;
  47         /** @var string */
  48         protected $provider_url;
  49         /** @var int */
  50         protected $width;
  51         /** @var int */
  52         protected $height;
  53         /** @var string */
  54         protected $image;
  55
  56         /**
  57          * Creates a card record from an attachment array.
  58          *
  59          * @param array   $attachment Attachment record
  60          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  61          */
  62         public function __construct(array $attachment)
  63         {
  64                 $this->url           = $attachment['url'] ?? '';
  65                 $this->title         = $attachment['title'] ?? '';
  66                 $this->description   = $attachment['description'] ?? '';
  67                 $this->type          = $attachment['type'] ?? '';
  68                 $this->author_name   = $attachment['author_name'] ?? '';
  69                 $this->author_url    = $attachment['author_url'] ?? '';
  70                 $this->provider_name = $attachment['provider_name'] ?? '';
  71                 $this->provider_url  = $attachment['provider_url'] ?? '';
  72                 $this->width         = $attachment['width'] ?? 0;
  73                 $this->height        = $attachment['height'] ?? 0;
  74                 $this->image         = $attachment['image'] ?? '';
  75         }
  76
  77         /**
  78          * Returns the current entity as an array
  79          *
  80          * @return array
  81          */
  82         public function toArray(): array
  83         {
  84                 if (empty($this->url)) {
  85                         return [];
  86                 }
  87
  88                 return parent::toArray();
  89         }
  90 }