src/Object/Api/Mastodon/Error.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 Error
  28  *
  29  * @see https://docs.joinmastodon.org/entities/error
  30  */
  31 class Error extends BaseDataTransferObject
  32 {
  33         /** @var string */
  34         protected $error;
  35         /** @var string */
  36         protected $error_description;
  37
  38         /**
  39          * Creates an error record
  40          *
  41          * @param string $error
  42          * @param string error_description
  43          */
  44         public function __construct(string $error, string $error_description)
  45         {
  46                 $this->error             = $error;
  47                 $this->error_description = $error_description;
  48         }
  49
  50         /**
  51          * Returns the current entity as an array
  52          *
  53          * @return array
  54          */
  55         public function toArray(): array
  56         {
  57                 $error = parent::toArray();
  58
  59                 if (empty($error['error_description'])) {
  60                         unset($error['error_description']);
  61                 }
  62
  63                 return $error;
  64         }
  65 }