API Documentation
Back to top  

WithdrawalJsonSerializer

Extends \AbstractJsonSerializer

Class WithdrawalJsonSerializer

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

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

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

Serializes withdrawal collections.

serializeWithdrawalCollection(\WithdrawalCollection $withdrawalCollection, boolean $encode = true) : string|array

Arguments

$withdrawalCollection

\WithdrawalCollection

Withdrawal collection to be serialized.

$encode

boolean

(optional) Whether to json_encode the result of the method (default true).

Response

string|array

Returns the json encoded withdrawal collection(string) or an array that can be easily encoded into a JSON string.

Properties