Class ProductJsonSerializer

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

AbstractJsonSerializer implements SerializerInterface

ProductJsonSerializer

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

Methods summary

`public string\|array`	# `serialize( ProductInterface $object, boolean $encode = true )` Serialize a Product object to a JSON string. Serialize a Product 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 product (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.
`public ProductInterface`	# `deserialize( string $string, object $baseObject = null )` Deserialize a Product JSON String. Deserialize a Product JSON String. Parameters `$string` JSON string that contains the data of the product. `$baseObject` (optional) If provided, this will be the base object to be updated and no new instance will be created. Returns `ProductInterface` Returns the deserialized Product object. Throws InvalidArgumentException If the argument is not a string or is empty.
`protected array`	# `_serializeImages( ProductImageContainerInterface $imageContainer )` Serialize Images Serialize Images Parameters `$imageContainer` Returns array
`protected ProductImageContainer`	# `_deserializeImages( $json )` Deserialize Images Deserialize Images Parameters `$json` Returns `ProductImageContainer` Throws InvalidArgumentException Through "addAdditional" RuntimeException Through "_deserializeLanguageSpecificProperty"
`protected array`	# `_serializeSettings( ProductSettingsInterface $settings )` Serialize Settings Serialize Settings Parameters `$settings` Returns array
`protected ProductSettingsInterface`	# `_deserializeSettings( ProductSettingsInterface $settings, $json )` Deserialize Settings Deserialize Settings Parameters `$settings` `$json` Returns `ProductSettingsInterface`

Methods inherited from AbstractJsonSerializer

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

Properties summary

Properties inherited from AbstractJsonSerializer

$languageProvider

Packages

Classes

Interfaces

Class ProductJsonSerializer

Methods summary

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Methods inherited from AbstractJsonSerializer

Properties summary

Properties inherited from AbstractJsonSerializer