Class CustomerJsonSerializer

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

AbstractJsonSerializer implements SerializerInterface

CustomerJsonSerializer

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

Methods summary

`public string\|array`	# `serialize( CustomerInterface $object, boolean $encode = true )` Serialize customer object to json string. Serialize customer object to json string. Important: Password value will not be included in the serialized object. Parameters `$object` Contains the customer 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 customer (string) or an array that can be easily encoded into a JSON string. Throws InvalidArgumentException If the provided object type is invalid.
`public CustomerInterface`	# `deserialize( string $string, object $baseObject = null )` Deserialize customer JSON string. Deserialize customer JSON string. Parameters `$string` JSON string that contains the data of the customer. `$baseObject` (optional) If provided, this will be the base object to be updated and no new instance will be created. Returns `CustomerInterface` Returns the deserialized Customer 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