Class AddressJsonSerializer

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

AbstractJsonSerializer implements SerializerInterface

AddressJsonSerializer

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

Methods summary

`public string\|array`	# `serialize( CustomerAddressInterface $object, boolean $encode = true )` Serialize address object to JSON string. Serialize address object to JSON string. Parameters `$object` Contains the address data. `$encode` (optional) Whether to json_encode the result of the method (default true). Sometimes it might be required to encode an array of multiple customer records together and not one by one. Returns string\|array Returns the json encoded address (string) or an array that can be easily encoded into a JSON string. Throws InvalidArgumentException If the provided object type is invalid.
`public CustomerAddressInterface`	# `deserialize( string $string, object $baseObject = null )` Deserialize address JSON string. Deserialize address JSON string. Parameters `$string` JSON string that contains the data of the address. `$baseObject` (optional) If provided, this will be the base object to be updated and no new instance will be created. Returns `CustomerAddressInterface` Returns the deserialized Address object. Throws InvalidArgumentException If the argument is not a string or is empty.

Methods inherited from AbstractJsonSerializer

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

Properties summary

Properties inherited from AbstractJsonSerializer

$languageProvider

Packages

Classes

Interfaces