dto_constructor.md

Пример работы конструктора DTO Mindbox

DTO в Mindbox SDK используются для упрощения формирования тела запроса и работы с ответом от Mindbox API.

Конструктор DTO принимает в качестве параметра массив данных и рекурсивно сериализует переданный массив в объекты DTO.

Любая DTO может быть сериализована в XML или JSON.

Пример

$operation = new \Mindbox\DTO\V3\OperationDTO([
    'customer' => [
        'firstName'     => 'some_firstName',
        'middleName'    => 'some_middleName',
        'lastName'      => 'some_lastName',
        'mobilePhone'   => 'some_mobilePhone',
        'subscriptions' => [
            [
                'pointOfContact' => 'some_pointOfContact',
                'topic'          => 'some_topic',
            ],
            [
                'pointOfContact' => 'second_pointOfContact',
                'topic'          => 'second_topic',
            ],
        ],
    ],
]);

echo 'XML:'. PHP_EOL;
echo $operation->toXML();
echo 'JSON:'. PHP_EOL;
echo $operation->toJson();

Вывод:

XML:
<?xml version="1.0" encoding="utf-8"?>
<operation>
    <customer>
        <firstName>some_firstName</firstName>
        <middleName>some_middleName</middleName>
        <lastName>some_lastName</lastName>
        <mobilePhone>some_mobilePhone</mobilePhone>
        <subscriptions>
            <subscription>
                <pointOfContact>some_pointOfContact</pointOfContact>
                <topic>some_topic</topic>
            </subscription>
            <subscription>
                <pointOfContact>second_pointOfContact</pointOfContact>
                <topic>second_topic</topic>
            </subscription>
        </subscriptions>
    </customer>
</operation>

JSON:
{
    "customer": {
        "firstName":"some_firstName",
        "middleName":"some_middleName",
        "lastName":"some_lastName",
        "mobilePhone":"some_mobilePhone",
        "subscriptions":[
            {
                "pointOfContact":"some_pointOfContact",
                "topic":"some_topic"
            },
            {
                "pointOfContact":"second_pointOfContact",
                "topic":"second_topic"
            }
        ]
    }
}

Вы можете передать в конструктор также те поля, которые не описаны в DTO.

Пример:

$operation = new \Mindbox\DTO\V3\OperationDTO([
   'customer' => [
       'firstName'        => 'some_firstName',
       'middleName'       => 'some_middleName',
       'someField'        => 'someValue',
       'someArrayField'   => [
           'arrayField1'  => 'arrayField1Value',
           'arrayField2'  => 'arrayField2Value',
       ],
       'someArrayFieldsWithNameByDefault'  => [
           [
               'firstArrayField'  => 'firstArrayFieldValue'
           ],
           [
               'secondArrayField' => 'secondArrayFieldValue'
           ],
       ],
       'someArrayFields'  => [
           [
               'firstArrayField'  => 'firstArrayFieldValue'
           ],
           [
               'secondArrayField' => 'secondArrayFieldValue'
           ],
           '@itemName' => 'someArrayField', // укажите название элементов массива, если поле не описано в DTO для корректной генерации xml
       ],
   ],
]);

echo 'XML:'. PHP_EOL;
echo $operation->toXML();
echo 'JSON:'. PHP_EOL;
echo $operation->toJson();

Вывод:

XML:
<?xml version="1.0" encoding="utf-8"?>
<operation>
    <customer>
        <firstName>some_firstName</firstName>
        <middleName>some_middleName</middleName>
        <someField>someValue</someField>
        <someArrayField>
            <arrayField1>arrayField1Value</arrayField1>
            <arrayField2>arrayField2Value</arrayField2>
        </someArrayField>
        <someArrayFieldsWithNameByDefault>
            <value>
                <firstArrayField>firstArrayFieldValue</firstArrayField>
            </value>
            <value>
                <secondArrayField>secondArrayFieldValue</secondArrayField>
            </value>
        </someArrayFieldsWithNameByDefault>
        <someArrayFields>
            <someArrayField>
                <firstArrayField>firstArrayFieldValue</firstArrayField>
            </someArrayField>
            <someArrayField>
                <secondArrayField>secondArrayFieldValue</secondArrayField>
            </someArrayField>
        </someArrayFields>
    </customer>
</operation>

JSON:
{
    "customer":{
        "firstName":"some_firstName",
        "middleName":"some_middleName",
        "someField":"someValue",
        "someArrayField":{
            "arrayField1":"arrayField1Value",
            "arrayField2":"arrayField2Value"
        },
        "someArrayFieldsWithNameByDefault":[
            {
                "firstArrayField":"firstArrayFieldValue"
            },
            {
                "secondArrayField":"secondArrayFieldValue"
            }
        ],
        "someArrayFields":[
            {
                "firstArrayField":"firstArrayFieldValue"
            },
            {
                "secondArrayField":"secondArrayFieldValue"
            }
        ]
    }
}