src/Object/Api/Mastodon/Emoji.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\BaseEntity;
  25
  26 /**
  27  * Class Emoji
  28  *
  29  * @see https://docs.joinmastodon.org/entities/emoji/
  30  */
  31 class Emoji extends BaseEntity
  32 {
  33         //Required attributes
  34         /** @var string */
  35         protected $shortcode;
  36         /** @var string (URL)*/
  37         protected $static_url;
  38         /** @var string (URL)*/
  39         protected $url;
  40         /**
  41          * Unsupported
  42          * @var bool
  43          */
  44         protected $visible_in_picker = true;
  45
  46         // Optional attributes
  47         /**
  48          * Unsupported
  49          * @var string
  50          */
  51         //protected $category;
  52
  53         public function __construct(string $shortcode, string $url)
  54         {
  55                 $this->shortcode = $shortcode;
  56                 $this->url = $url;
  57                 $this->static_url = $url;
  58         }
  59
  60         /**
  61          * @param Emoji  $prototype
  62          * @param string $shortcode
  63          * @param string $url
  64          * @return Emoji
  65          */
  66         public static function createFromPrototype(Emoji $prototype, string $shortcode, string $url)
  67         {
  68                 $emoji = clone $prototype;
  69                 $emoji->shortcode = $shortcode;
  70                 $emoji->url = $url;
  71                 $emoji->static_url = $url;
  72
  73                 return $emoji;
  74         }
  75 }