includes/json/JsonDeserializableTrait.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @ingroup Json
  20  */
  21
  22 namespace MediaWiki\Json;
  23
  24 trait JsonDeserializableTrait {
  25
  26         public function jsonSerialize(): array {
  27                 return $this->annotateJsonForDeserialization(
  28                         $this->toJsonArray()
  29                 );
  30         }
  31
  32         /**
  33          * Annotate the $json array with class metadata.
  34          *
  35          * @param array $json
  36          * @return array
  37          */
  38         private function annotateJsonForDeserialization( array $json ): array {
  39                 $json[JsonConstants::TYPE_ANNOTATION] = get_class( $this );
  40                 return $json;
  41         }
  42
  43         /**
  44          * Prepare this object for JSON serialization.
  45          * The returned array will be passed to self::newFromJsonArray
  46          * upon JSON deserialization.
  47          * @return array
  48          */
  49         abstract protected function toJsonArray(): array;
  50 }
  51
  52 /** @deprecated class alias since 1.43 */
  53 class_alias( JsonDeserializableTrait::class, 'MediaWiki\\Json\\JsonUnserializableTrait' );