Inheritance diagram for MediaWiki\Json\JsonCodec:

[legend]

Collaboration diagram for MediaWiki\Json\JsonCodec:

[legend]

Public Member Functions
	detectNonSerializableData ( $value, bool $expectUnserialize=false)
	Checks if the $value is JSON-serializable (contains only scalar values) and returns a JSON-path to the first non-serializable property encountered.

	serialize ( $value)
	Encode $value as JSON with an intent to use JsonUnserializer::unserialize to decode it back.

	unserialize ( $json, string $expectedClass=null)
	Restore an instance of simple type or JsonUnserializable subclass from the JSON serialization.

	unserializeArray (array $array)
	Helper to unserialize an array of JsonUnserializable instances or simple types.

Private Member Functions
	canMakeNewFromValue ( $json)
	Is it likely possible to make a new instance from $json serialization?

	detectNonSerializableDataInternal ( $value, bool $expectUnserialize, string $accumulatedPath)
	Recursive check for ability to serialize $value to JSON via FormatJson::encode().

Detailed Description

Definition at line 36 of file JsonCodec.php.

Member Function Documentation

◆ canMakeNewFromValue()

MediaWiki\Json\JsonCodec::canMakeNewFromValue ( $json )

private

Is it likely possible to make a new instance from $json serialization?

Parameters

mixed $json

Returns: bool

Definition at line 122 of file JsonCodec.php.

Referenced by MediaWiki\Json\JsonCodec\unserialize(), and MediaWiki\Json\JsonCodec\unserializeArray().

◆ detectNonSerializableData()

MediaWiki\Json\JsonCodec::detectNonSerializableData	(		$value,
		bool	$expectUnserialize = `false`
	)

Checks if the $value is JSON-serializable (contains only scalar values) and returns a JSON-path to the first non-serializable property encountered.

Parameters

mixed	$value
bool	$expectUnserialize	whether to expect the $value to be unserializable with JsonUnserializer.

Returns: string|null JSON path to first encountered non-serializable property or null.

See also: JsonUnserializer

Since: 1.36

Definition at line 181 of file JsonCodec.php.

◆ detectNonSerializableDataInternal()

MediaWiki\Json\JsonCodec::detectNonSerializableDataInternal	(		$value,
		bool	$expectUnserialize,
		string	$accumulatedPath
	)

private

Recursive check for ability to serialize $value to JSON via FormatJson::encode().

Parameters

mixed	$value
bool	$expectUnserialize
string	$accumulatedPath

Returns: string|null JSON path to first encountered non-serializable property or null.

Definition at line 142 of file JsonCodec.php.

◆ serialize()

MediaWiki\Json\JsonCodec::serialize ( $value )

Encode $value as JSON with an intent to use JsonUnserializer::unserialize to decode it back.

Parameters

mixed | JsonUnserializable $value A value to encode. Can be any scalar, array, stdClass, JsonUnserializable or any combination of them.

Exceptions

InvalidArgumentException if the value can not be serialized.

Returns: string

Implements MediaWiki\Json\JsonSerializer.

Definition at line 89 of file JsonCodec.php.

References FormatJson\ALL_OK, and FormatJson\encode().

◆ unserialize()

MediaWiki\Json\JsonCodec::unserialize	(		$json,
		string	$expectedClass = `null`
	)

Restore an instance of simple type or JsonUnserializable 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 unserialized as PHP associative arrays and not as instances of \stdClass.

@phpcs:ignore MediaWiki.Commenting.FunctionComment.ObjectTypeHintParam

Parameters

array \| string \| object	$json
string \| null	$expectedClass	What class to expect in unserialization. If null, no expectation. Must be a descendant of JsonUnserializable.

Exceptions

InvalidArgumentException if the passed $json can't be unserialized.