19f4e6945a
This is to make it clearer that they're related to converting serialized content back into JSON, rather than stating that things are not representable in JSON. Change-Id: Ic440ac2d05b5ac238a1c0e4821d3f2d858bc3d76
75 lines
2.3 KiB
PHP
75 lines
2.3 KiB
PHP
<?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' );
|