File: JsonDeserializableCodec.php

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (59 lines) | stat: -rw-r--r-- 1,776 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<?php
/**
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @ingroup Json
 */

namespace MediaWiki\Json;

use Wikimedia\JsonCodec\JsonClassCodec;

/**
 * A JsonClassCodec for objects implementing the JsonDeserializable interface.
 *
 * @see JsonDeserializer
 * @see JsonDeserializableTrait
 * @see JsonClassCodec
 * @since 1.43
 */
class JsonDeserializableCodec implements JsonClassCodec {
	private JsonDeserializer $codec;

	public function __construct( JsonDeserializer $codec ) {
		$this->codec = $codec;
	}

	/** @inheritDoc */
	public function toJsonArray( $obj ): array {
		$result = $obj->jsonSerialize();
		// Undo the work of JsonDeserializableTrait to avoid
		// redundant storage of TYPE_ANNOTATION
		unset( $result[JsonConstants::TYPE_ANNOTATION] );
		return $result;
	}

	/** @inheritDoc */
	public function newFromJsonArray( string $className, array $json ) {
		return $className::newFromJsonArray( $this->codec, $json );
	}

	/** @inheritDoc */
	public function jsonClassHintFor( string $className, string $keyName ) {
		return null;
	}
}