AddressJsonSerializer

Extends \AbstractJsonSerializer

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.

category

System

package

Extensions

subpackage

Serializers

Methods

AbstractJsonSerializer Constructor

__construct() 
inherited

If you override this constructor do not forget to call it from the child class.

Deserialize Addon Values

_deserializeAddonValues( $json) : array
inherited

Common method for deserializing addon values in various resource serializer classes.

Arguments

$json

Response

array

Deserialize Language Specific Property

_deserializeLanguageSpecificProperty(mixed $object, \stdobject $json, string $property,  $type = 'StringType') 
inherited

This method will deserialize the value of a JSON property and set the value to the object by using the corresponding setter method.

Throws
\RuntimeException

If the setter method does not exist.

Arguments

$object

mixed

The object being deserialized.

$json

\stdobject

The JSON object containing the property value.

$property

string

The property name to be deserialized.

$type

Serialize Addon Values

_serializeAddonValues(\KeyValueCollection $addonValues) : array
inherited

Common method for serializing addon values in various resource serializer classes.

Arguments

$addonValues

\KeyValueCollection

Response

array

Serialize Language Specific Property

_serializeLanguageSpecificProperty(mixed $object, string $property) : array
inherited

In order for this method to work there has to be a proper getter method in the object instance. Otherwise a RuntimeException will be thrown.

Throws
\RuntimeException

If there is no getter for the provided property.

Arguments

$object

mixed

The object instance containing the property.

$property

string

The property name to be serialized.

Response

array

deserialize

deserialize( $string,  $baseObject = null) 
inherited abstract

Arguments

$string

$baseObject

JSON Encode Wrapper

jsonEncode(array $data) : string
inherited

This function provides PHP v5.3 compatibility and it should be used when serialized objects need to be encoded directly from the serializer instance.

Arguments

$data

array

Contains the data to be JSON encoded.

Response

string

Returns the encoded JSON string that represents the data.

serialize

serialize( $object,  $encode = true) 
inherited abstract

Arguments

$object

$encode

Properties

Used for the resources that require multiple languages.

languageProvider : \LanguageProviderInterface
inherited