includes/json/JsonDeserializableCodec.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 use Wikimedia\JsonCodec\JsonClassCodec;
  25
  26 /**
  27  * A JsonClassCodec for objects implementing the JsonDeserializable interface.
  28  *
  29  * @see JsonDeserializer
  30  * @see JsonDeserializableTrait
  31  * @see JsonClassCodec
  32  * @since 1.43
  33  */
  34 class JsonDeserializableCodec implements JsonClassCodec {
  35         private JsonDeserializer $codec;
  36
  37         public function __construct( JsonDeserializer $codec ) {
  38                 $this->codec = $codec;
  39         }
  40
  41         /** @inheritDoc */
  42         public function toJsonArray( $obj ): array {
  43                 $result = $obj->jsonSerialize();
  44                 // Undo the work of JsonDeserializableTrait to avoid
  45                 // redundant storage of TYPE_ANNOTATION
  46                 unset( $result[JsonConstants::TYPE_ANNOTATION] );
  47                 return $result;
  48         }
  49
  50         /** @inheritDoc */
  51         public function newFromJsonArray( string $className, array $json ) {
  52                 return $className::newFromJsonArray( $this->codec, $json );
  53         }
  54
  55         /** @inheritDoc */
  56         public function jsonClassHintFor( string $className, string $keyName ) {
  57                 return null;
  58         }
  59 }