Class CategoryJsonSerializer

This class will serialize and deserialize a Category entity. It can be used into many places where PHP interacts with external requests such as AJAX or API communication.

AbstractJsonSerializer implements SerializerInterface

CategoryJsonSerializer

Package: Extensions\Serializers
Category: System
Located at Extensions/Serializers/CategoryJsonSerializer.inc.php

Methods summary

`public string\|array`	# `serialize( StoredCategoryInterface $object, boolean $encode = true )` Serialize a Category object to a JSON string. Serialize a Category object to a JSON string. Parameters `$object` Object instance to be serialized. `$encode` (optional) Whether to json_encode the result of the method (default true). Returns string\|array Returns the json encoded category (string) or an array that can be easily encoded into a JSON string. Throws InvalidArgumentException If the provided object type is invalid. RuntimeException Through the _serializeLanguageSpecificProperty method.
`public CategoryInterface`	# `deserialize( string $string, object $baseObject = null )` Deserialize a Category JSON String. Deserialize a Category JSON String. Parameters `$string` JSON string that contains the data of the category. `$baseObject` (optional) If provided, this will be the base object to be updated and no new instance will be created. Returns `CategoryInterface` Returns the deserialized Category object. Throws InvalidArgumentException If the argument is not a string or is empty.
`protected`	# `_serializeSettings( CategorySettingsInterface $settings )`
`protected`	# `_deserializeSettings( CategorySettingsInterface $settings, $json )`

Methods inherited from AbstractJsonSerializer

__construct(), _deserializeAddonValues(), _deserializeLanguageSpecificProperty(), _serializeAddonValues(), _serializeLanguageSpecificProperty(), jsonEncode()

Properties summary

Properties inherited from AbstractJsonSerializer

$languageProvider

Packages

Classes

Interfaces