src/Object/Api/Mastodon/Token.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
  26 /**
  27  * Class Token
  28  *
  29  * @see https://docs.joinmastodon.org/entities/token/
  30  */
  31 class Token extends BaseDataTransferObject
  32 {
  33         /** @var string */
  34         protected $access_token;
  35         /** @var string */
  36         protected $token_type;
  37         /** @var string */
  38         protected $scope;
  39         /** @var int (timestamp) */
  40         protected $created_at;
  41         /** @var string */
  42         protected $me;
  43
  44         /**
  45          * Creates a token record
  46          *
  47          * @param string $access_token Token string
  48          * @param string $token_type   Always "Bearer"
  49          * @param string $scope        Combination of "read write follow push"
  50          * @param string $created_at   Creation date of the token
  51          * @param string $me           Actor profile of the token owner
  52          */
  53         public function __construct(string $access_token, string $token_type, string $scope, string $created_at, string $me = null)
  54         {
  55                 $this->access_token = $access_token;
  56                 $this->token_type   = $token_type;
  57                 $this->scope        = $scope;
  58                 $this->created_at   = strtotime($created_at);
  59                 $this->me           = $me;
  60         }
  61
  62         /**
  63          * Returns the current entity as an array
  64          *
  65          * @return array
  66          */
  67         public function toArray(): array
  68         {
  69                 $token = parent::toArray();
  70
  71                 if (empty($token['me'])) {
  72                         unset($token['me']);
  73                 }
  74
  75                 return $token;
  76         }
  77 }