Class CountryJsonSerializer

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

AbstractJsonSerializer implements SerializerInterface

CountryJsonSerializer

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

Methods summary

`public string\|array`	# `serialize( CustomerCountryInterface $object, boolean $encode = true )` Serialize country object to json string. Serialize country object to json string. Parameters `$object` Contains the country 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 country records together and not one by one. Returns string\|array Returns the json encoded country (string) or an array that can be easily encoded into a JSON string. Throws InvalidArgumentException If the provided object type is invalid.
`public CustomerCountryInterface`	# `deserialize( string $string, object $baseObject = null )` Deserialize country JSON string. Deserialize country JSON string. NOTICE #1: The CountryService does not support the addition of new countries so the CustomerCountry object does not have any setters, rather only getters. So the $baseObject parameter is not used at all. NOTICE #2: The provided JSON string must contain all the properties of the country otherwise the object will not be deserialized. Parameters `$string` JSON string that contains the data of the country. `$baseObject` (optional) It is not used within the countries context. Returns `CustomerCountryInterface` Returns the deserialized CustomerCountry 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