src/Object/Api/Twitter/Mention.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\Twitter;
  23
  24 use Friendica\App\BaseURL;
  25 use Friendica\BaseDataTransferObject;
  26
  27 /**
  28  * Class Mention
  29  *
  30  * @see https://developer.twitter.com/en/docs/twitter-api/v1/data-dictionary/object-model/entities#mentions
  31  */
  32 class Mention extends BaseDataTransferObject
  33 {
  34         /** @var int */
  35         protected $id;
  36         /** @var string */
  37         protected $id_str;
  38         /** @var array */
  39         protected $indices;
  40         /** @var string */
  41         protected $name;
  42         /** @var string */
  43         protected $screen_name;
  44
  45         /**
  46          * Creates a mention record from an tag-view record.
  47          *
  48          * @param BaseURL $baseUrl
  49          * @param array   $tag     tag-view record
  50          * @param array   $contact contact table record
  51          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  52          */
  53         public function __construct(array $tag, array $contact, array $indices)
  54         {
  55                 $this->id          = (string)($contact['id'] ?? 0);
  56                 $this->id_str      = (string)($contact['id'] ?? 0);
  57                 $this->indices     = $indices;
  58                 $this->name        = $tag['name'];
  59                 $this->screen_name = $contact['nick'];
  60         }
  61
  62         /**
  63          * Returns the current entity as an array
  64          *
  65          * @return array
  66          */
  67         public function toArray(): array
  68         {
  69                 $status = parent::toArray();
  70
  71                 if (empty($status['indices'])) {
  72                         unset($status['indices']);
  73                 }
  74
  75                 return $status;
  76         }
  77 }