Class OrderListItemJsonSerializer

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

AbstractJsonSerializer implements SerializerInterface

OrderListItemJsonSerializer

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

Methods summary

`public string\|array`	# `serialize( OrderListItem $object, boolean $encode = true )` Serialize an OrderListItem object to a JSON string. Serialize an OrderListItem object to a JSON string. Parameters `$object` Object instance to be serialized. `$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 order list item (string) or an array that can be easily encoded into a JSON string. Throws InvalidArgumentException If the provided object type is invalid.
`public`	# `deserialize( string $string, stdClass $baseObject = null )` Deserialize method is not used by the api. Deserialize method is not used by the api. Parameters `$string` JSON string that contains the data of the address. `$baseObject` (optional) This parameter is not supported for this serializer because the OrderListItem does not have any setter methods. Throws RuntimeException If the argument is not a string or is empty.
`protected array`	# `_serializeCustomerMemos( CustomerMemoCollection $customerMemoCollection )` Serialize Customer Memo Collection Serialize Customer Memo Collection Parameters `$customerMemoCollection` Returns array
`protected array`	# `_serializeOrderAddressBlock( OrderAddressBlock $orderAddressBlock )` Serialize Order AddressBlock Serialize Order AddressBlock Parameters `$orderAddressBlock` Returns array
`protected array`	# `_serializeWithdrawalIds( IdCollection $withdrawalIds )` Serialize WithdrawalIds Collection Serialize WithdrawalIds Collection Parameters `$withdrawalIds` Returns array

Methods inherited from AbstractJsonSerializer

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

Properties summary

Properties inherited from AbstractJsonSerializer

$languageProvider

Packages

Classes

Interfaces

Class OrderListItemJsonSerializer

Methods summary

Parameters

Returns

Throws

Parameters

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Methods inherited from AbstractJsonSerializer

Properties summary

Properties inherited from AbstractJsonSerializer