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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
<?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 InvalidArgumentException;
/**
* Deserializes things from JSON.
*
* @since 1.36
* @package MediaWiki\Json
*/
interface JsonDeserializer {
/**
* Restore an instance of simple type or JsonDeserializable subclass
* from the JSON serialization. It supports passing array/object to
* allow manual decoding of the JSON string if needed.
*
* @note JSON objects are unconditionally deserialized as PHP associative
* arrays, and not as instances of \stdClass.
*
* @phpcs:ignore MediaWiki.Commenting.FunctionComment.ObjectTypeHintParam
* @param array|string|object $json
* @param string|null $expectedClass What class to expect in deserialization.
* If null, no expectation. Must be a descendant of JsonDeserializable.
* @throws InvalidArgumentException if the passed $json can't be deserialized.
* @return mixed
*/
public function deserialize( $json, ?string $expectedClass = null );
/**
* Backwards-compatibility alias for deserialize()
*
* @deprecated since 1.43
*/
public function unserialize( $json, ?string $expectedClass = null );
/**
* Helper to deserialize an array of JsonDeserializable instances or simple types.
* @param array $array
* @return array
*/
public function deserializeArray( array $array ): array;
/**
* Backwards-compatibility alias for deserializeArray()
*
* @deprecated since 1.43
*/
public function unserializeArray( array $array ): array;
}
/** @deprecated class alias since 1.43 */
class_alias( JsonDeserializer::class, 'MediaWiki\\Json\\JsonUnserializer' );
|
