\Clx\XmsSerialize

A collection of static serialization functions.

These function are capable of serializing XMS API data objects in a manner suitable for XMS.

Summary

Methods
Properties
Constants
textBatch()
binaryBatch()
textBatchUpdate()
binaryBatchUpdate()
_groupAutoUpdateHelper()
group()
groupUpdate()
tags()
tagsUpdate()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

textBatch()

textBatch(\Clx\Xms\Api\MtBatchTextSmsCreate  $batch) : string

Serializes the given text batch into JSON.

Parameters

\Clx\Xms\Api\MtBatchTextSmsCreate $batch

the batch to serialize

Returns

string —

JSON formatted string

binaryBatch()

binaryBatch(\Clx\Xms\Api\MtBatchBinarySmsCreate  $batch) : string

Serializes the given binary batch into JSON.

Parameters

\Clx\Xms\Api\MtBatchBinarySmsCreate $batch

the batch to serialize

Returns

string —

JSON formatted string

textBatchUpdate()

textBatchUpdate(\Clx\Xms\Api\MtBatchTextSmsUpdate  $batch) : string

Serializes the given text batch update into JSON.

Parameters

\Clx\Xms\Api\MtBatchTextSmsUpdate $batch

the batch update to serialize

Returns

string —

JSON formatted string

binaryBatchUpdate()

binaryBatchUpdate(\Clx\Xms\Api\MtBatchBinarySmsUpdate  $batch) : string

Serializes the given binary batch update into JSON.

Parameters

\Clx\Xms\Api\MtBatchBinarySmsUpdate $batch

the batch update to serialize

Returns

string —

JSON formatted string

_groupAutoUpdateHelper()

_groupAutoUpdateHelper(\Clx\Xms\Api\GroupAutoUpdate  $autoUpdate) : array<mixed,>

Helper that prepares the given group auto update for JSON serialization.

Parameters

\Clx\Xms\Api\GroupAutoUpdate $autoUpdate

the auto update to serialize

Returns

array<mixed,> —

associative array suitable for JSON serialization

group()

group(\Clx\Xms\Api\GroupCreate  $group) : string

Serializes the given group create object to JSON.

Parameters

\Clx\Xms\Api\GroupCreate $group

the group to serialize

Returns

string —

a JSON string

groupUpdate()

groupUpdate(\Clx\Xms\Api\GroupUpdate  $groupUpdate) : string

Serializes the given group update object to JSON.

Parameters

\Clx\Xms\Api\GroupUpdate $groupUpdate

the group update to serialize

Returns

string —

a JSON string

tags()

tags(array<mixed,string>  $tags) : string

Serializes the given tags to a JSON string.

Parameters

array<mixed,string> $tags

a list of tags

Returns

string —

a JSON formatted text

tagsUpdate()

tagsUpdate(array<mixed,string>  $tagsToAdd, array<mixed,string>  $tagsToRemove) : string

Serializes the given tag updates to a JSON string.

Parameters

array<mixed,string> $tagsToAdd

list of tags

array<mixed,string> $tagsToRemove

list of tags

Returns

string —

a JSON formatted text