OrderJsonSerializer
extends AbstractJsonSerializer
in package
Class OrderJsonSerializer
This class will serialize and deserialize an Order entity. It can be used into many places where PHP interacts with external requests such as AJAX or API communication.
Tags
Table of Contents
- $languageProvider : LanguageProviderInterface
- Used for the resources that require multiple languages.
- __construct() : mixed
- AbstractJsonSerializer Constructor
- deserialize() : GXEngineOrder
- Deserialize an Order JSON String.
- deserializeAddress() : mixed
- deserializeAttribute() : mixed
- deserializeOrderItem() : mixed
- deserializeOrderTotal() : mixed
- jsonEncode() : string
- JSON Encode Wrapper
- serialize() : string|array<string|int, mixed>
- Serialize an Order object to a JSON string.
- serializeAddress() : mixed
- serializeAttribute() : mixed
- serializeOrderItem() : mixed
- serializeOrderStatusHistoryListItem() : mixed
- serializeOrderTotal() : mixed
- _deserializeAddonValues() : array<string|int, mixed>
- Deserialize Addon Values
- _deserializeLanguageSpecificProperty() : mixed
- Deserialize Language Specific Property
- _deserializeOrderItemDownloadInformation() : mixed
- _deserializeOrderItemGXCustomizerData() : array<string|int, mixed>
- _deserializeOrderItemGXCustomizerDataLegacy() : OrderItemGXCustomizerData
- deserialize gx customizer data
- _serializeAddonValues() : array<string|int, mixed>
- Serialize Addon Values
- _serializeLanguageSpecificProperty() : array<string|int, mixed>
- Serialize Language Specific Property
- _serializeOrderItemDownloadInformation() : mixed
- _serializeOrderItemGXCustomizerData() : mixed
- _serializeOrderItemGXCustomizerDataLegacy() : array<string|int, mixed>|OrderItemGXCustomizerData
- Returns the data for the gxCustomizerData
Properties
$languageProvider
Used for the resources that require multiple languages.
protected
LanguageProviderInterface
$languageProvider
Methods
__construct()
AbstractJsonSerializer Constructor
public
__construct() : mixed
If you override this constructor do not forget to call it from the child class.
Return values
mixed —deserialize()
Deserialize an Order JSON String.
public
deserialize(string $string[, object $baseObject = null ]) : GXEngineOrder
Parameters
- $string : string
-
JSON string that contains the data of the address.
- $baseObject : object = null
-
(optional) If provided, this will be the base object to be updated and no new instance will be created.
Tags
Return values
GXEngineOrder —Returns the deserialized Order object.
deserializeAddress()
public
deserializeAddress(mixed $json) : mixed
Parameters
- $json : mixed
Return values
mixed —deserializeAttribute()
public
deserializeAttribute(mixed $json[, mixed $baseObject = null ]) : mixed
Parameters
- $json : mixed
- $baseObject : mixed = null
Return values
mixed —deserializeOrderItem()
public
deserializeOrderItem(mixed $json[, mixed $baseObject = null ]) : mixed
Parameters
- $json : mixed
- $baseObject : mixed = null
Return values
mixed —deserializeOrderTotal()
public
deserializeOrderTotal(mixed $json[, mixed $baseObject = null ]) : mixed
Parameters
- $json : mixed
- $baseObject : mixed = null
Return values
mixed —jsonEncode()
JSON Encode Wrapper
public
jsonEncode(array<string|int, mixed> $data) : string
This function provides PHP v5.3 compatibility and it should be used when serialized objects need to be encoded directly from the serializer instance.
Parameters
- $data : array<string|int, mixed>
-
Contains the data to be JSON encoded.
Return values
string —Returns the encoded JSON string that represents the data.
serialize()
Serialize an Order object to a JSON string.
public
serialize(OrderInterface $object[, bool $encode = true ]) : string|array<string|int, mixed>
Parameters
- $object : OrderInterface
-
Object instance to be serialized.
- $encode : bool = true
-
(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.
Tags
Return values
string|array<string|int, mixed> —Returns the json encoded order (string) or an array that can be easily encoded into a JSON string.
serializeAddress()
public
serializeAddress(AddressBlockInterface $addressBlock) : mixed
Parameters
- $addressBlock : AddressBlockInterface
Return values
mixed —serializeAttribute()
public
serializeAttribute(OrderItemAttributeInterface $orderItemAttribute) : mixed
Parameters
- $orderItemAttribute : OrderItemAttributeInterface
Return values
mixed —serializeOrderItem()
public
serializeOrderItem(OrderItemInterface $orderItem) : mixed
Parameters
- $orderItem : OrderItemInterface
Return values
mixed —serializeOrderStatusHistoryListItem()
public
serializeOrderStatusHistoryListItem(OrderStatusHistoryListItem $orderStatusHistoryListItem) : mixed
Parameters
- $orderStatusHistoryListItem : OrderStatusHistoryListItem
Return values
mixed —serializeOrderTotal()
public
serializeOrderTotal(OrderTotalInterface $orderTotal) : mixed
Parameters
- $orderTotal : OrderTotalInterface
Return values
mixed —_deserializeAddonValues()
Deserialize Addon Values
protected
_deserializeAddonValues( $json) : array<string|int, mixed>
Common method for deserializing addon values in various resource serializer classes.
Parameters
Return values
array<string|int, mixed> —_deserializeLanguageSpecificProperty()
Deserialize Language Specific Property
protected
_deserializeLanguageSpecificProperty(mixed $object, stdobject $json, string $property[, mixed $type = 'StringType' ]) : mixed
This method will deserialize the value of a JSON property and set the value to the object by using the corresponding setter method.
Parameters
- $object : mixed
-
The object being deserialized.
- $json : stdobject
-
The JSON object containing the property value.
- $property : string
-
The property name to be deserialized.
- $type : mixed = 'StringType'
Tags
Return values
mixed —_deserializeOrderItemDownloadInformation()
protected
_deserializeOrderItemDownloadInformation(mixed $json) : mixed
Parameters
- $json : mixed
Return values
mixed —_deserializeOrderItemGXCustomizerData()
protected
_deserializeOrderItemGXCustomizerData(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
Return values
array<string|int, mixed> —_deserializeOrderItemGXCustomizerDataLegacy()
deserialize gx customizer data
protected
_deserializeOrderItemGXCustomizerDataLegacy(mixed $area, mixed $elementData) : OrderItemGXCustomizerData
Parameters
- $area : mixed
- $elementData : mixed
Tags
Return values
OrderItemGXCustomizerData —_serializeAddonValues()
Serialize Addon Values
protected
_serializeAddonValues(KeyValueCollection $addonValues) : array<string|int, mixed>
Common method for serializing addon values in various resource serializer classes.
Parameters
- $addonValues : KeyValueCollection
Return values
array<string|int, mixed> —_serializeLanguageSpecificProperty()
Serialize Language Specific Property
protected
_serializeLanguageSpecificProperty(mixed $object, string $property) : array<string|int, mixed>
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.
Parameters
- $object : mixed
-
The object instance containing the property.
- $property : string
-
The property name to be serialized.
Tags
Return values
array<string|int, mixed> —_serializeOrderItemDownloadInformation()
protected
_serializeOrderItemDownloadInformation(OrderItemDownloadInformation $downloadInformation) : mixed
Parameters
- $downloadInformation : OrderItemDownloadInformation
Return values
mixed —_serializeOrderItemGXCustomizerData()
protected
_serializeOrderItemGXCustomizerData(array<string|int, mixed> $gxCustomizerDataCollectionArray) : mixed
Parameters
- $gxCustomizerDataCollectionArray : array<string|int, mixed>
Return values
mixed —_serializeOrderItemGXCustomizerDataLegacy()
Returns the data for the gxCustomizerData
protected
_serializeOrderItemGXCustomizerDataLegacy(array<string|int, mixed> $gxCustomizerDataCollectionArray) : array<string|int, mixed>|OrderItemGXCustomizerData
Parameters
- $gxCustomizerDataCollectionArray : array<string|int, mixed>