src/Object/Api/Mastodon/Attachment.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, 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\Core\Logger;
  26 use Friendica\Core\System;
  27
  28 /**
  29  * Class Attachment
  30  *
  31  * @see https://docs.joinmastodon.org/entities/attachment
  32  */
  33 class Attachment extends BaseDataTransferObject
  34 {
  35         /** @var string */
  36         protected $id;
  37         /** @var string */
  38         protected $type;
  39         /** @var string */
  40         protected $url;
  41         /** @var string */
  42         protected $preview_url;
  43         /** @var string */
  44         protected $remote_url;
  45         /** @var string */
  46         protected $text_url;
  47         /** @var string */
  48         protected $description;
  49         /** @var string */
  50         protected $blurhash;
  51         /** @var array */
  52         protected $meta;
  53
  54         /**
  55          * Creates an attachment
  56          *
  57          * @param array $attachment Expected keys: id, description
  58          *                          If $type == 'image': width, height[, preview-width, preview-height]
  59          * @param string $type      One of: audio, video, gifv, image, unknown
  60          * @param string $url
  61          * @param string $preview
  62          * @param string $remote
  63          */
  64         public function __construct(array $attachment, string $type, string $url, string $preview, string $remote)
  65         {
  66                 $this->id = (string)$attachment['id'];
  67                 $this->type = $type;
  68                 $this->url = $url;
  69                 $this->preview_url = $preview;
  70                 $this->remote_url = $remote;
  71                 $this->text_url = $this->remote_url ?? $this->url;
  72                 $this->description = $attachment['description'];
  73                 $this->blurhash = $attachment['blurhash'];
  74                 if ($type === 'image') {
  75                         if ((int) $attachment['width'] > 0 && (int) $attachment['height'] > 0) {
  76                                 $this->meta['original']['width'] = (int) $attachment['width'];
  77                                 $this->meta['original']['height'] = (int) $attachment['height'];
  78                                 $this->meta['original']['size'] = (int) $attachment['width'] . 'x' . (int) $attachment['height'];
  79                                 $this->meta['original']['aspect'] = (float) ((int)  $attachment['width'] / (int) $attachment['height']);
  80                         }
  81
  82                         if (isset($attachment['preview-width']) && (int) $attachment['preview-width'] > 0 && (int) $attachment['preview-height'] > 0) {
  83                                 $this->meta['small']['width'] = (int) $attachment['preview-width'];
  84                                 $this->meta['small']['height'] = (int) $attachment['preview-height'];
  85                                 $this->meta['small']['size'] = (int) $attachment['preview-width'] . 'x' . (int) $attachment['preview-height'];
  86                                 $this->meta['small']['aspect'] = (float) ((int)  $attachment['preview-width'] / (int) $attachment['preview-height']);
  87                         }
  88                 }
  89         }
  90
  91         /**
  92          * Returns the current entity as an array
  93          *
  94          * @return array
  95          */
  96         public function toArray(): array
  97         {
  98                 $attachment = parent::toArray();
  99
 100                 if (empty($attachment['remote_url'])) {
 101                         $attachment['remote_url'] = null;
 102                 }
 103
 104                 return $attachment;
 105         }
 106 }