3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Object\Api\Mastodon;
24 use Friendica\BaseDataTransferObject;
25 use Friendica\Core\Logger;
26 use Friendica\Core\System;
31 * @see https://docs.joinmastodon.org/entities/attachment
33 class Attachment extends BaseDataTransferObject
42 protected $preview_url;
44 protected $remote_url;
48 protected $description;
53 * Creates an attachment
55 * @param array $attachment Expected keys: id, description
56 * If $type == 'image': width, height[, preview-width, preview-height]
57 * @param string $type One of: audio, video, gifv, image, unknown
59 * @param string $preview
60 * @param string $remote
62 public function __construct(array $attachment, string $type, string $url, string $preview, string $remote)
64 $this->id = (string)$attachment['id'];
67 $this->preview_url = $preview;
68 $this->remote_url = $remote;
69 $this->text_url = $this->remote_url ?? $this->url;
70 $this->description = $attachment['description'];
71 if ($type === 'image') {
72 if ((int) $attachment['width'] > 0 && (int) $attachment['height'] > 0) {
73 $this->meta['original']['width'] = (int) $attachment['width'];
74 $this->meta['original']['height'] = (int) $attachment['height'];
75 $this->meta['original']['size'] = (int) $attachment['width'] . 'x' . (int) $attachment['height'];
76 $this->meta['original']['aspect'] = (float) ((int) $attachment['width'] / (int) $attachment['height']);
79 if (isset($attachment['preview-width']) && (int) $attachment['preview-width'] > 0 && (int) $attachment['preview-height'] > 0) {
80 $this->meta['small']['width'] = (int) $attachment['preview-width'];
81 $this->meta['small']['height'] = (int) $attachment['preview-height'];
82 $this->meta['small']['size'] = (int) $attachment['preview-width'] . 'x' . (int) $attachment['preview-height'];
83 $this->meta['small']['aspect'] = (float) ((int) $attachment['preview-width'] / (int) $attachment['preview-height']);
89 * Returns the current entity as an array
93 public function toArray(): array
95 $attachment = parent::toArray();
97 if (empty($attachment['remote_url'])) {
98 $attachment['remote_url'] = null;