Mindbox-DTO-V3-Responses-PaymentResponseDTO.md

Mindbox\DTO\V3\Responses\PaymentResponseDTO

Class PaymentResponseDTO

• Class name: PaymentResponseDTO
• Namespace: Mindbox\DTO\V3\Responses
• Parent class: Mindbox\DTO\V3\PaymentDTO

Constants

XML_ITEM_NAME_INDEX

const XML_ITEM_NAME_INDEX = '@itemName'

Properties

$DTOMap

protected array $DTOMap = array()

• Visibility: protected
• This property is static.

$xmlName

protected string $xmlName = 'dto'

• Visibility: protected
• This property is static.

$items

protected array $items = array()

• Visibility: protected

$id

public string $id

• Visibility: public

$promoActionId

public string $promoActionId

• Visibility: public

$creditCard

public \Mindbox\DTO\V3\Responses\CreditCardResponseDTO $creditCard

• Visibility: public

$balanceType

public \Mindbox\DTO\V3\Responses\BalanceTypeResponseDTO $balanceType

• Visibility: public

$type

public string $type

• Visibility: public
• This property is defined by Mindbox\DTO\V3\PaymentDTO

$amount

public string $amount

• Visibility: public
• This property is defined by Mindbox\DTO\V3\PaymentDTO

Methods

getId

string Mindbox\DTO\V3\Responses\PaymentResponseDTO::getId()

• Visibility: public

getPromoActionId

string Mindbox\DTO\V3\Responses\PaymentResponseDTO::getPromoActionId()

• Visibility: public

getCreditCard

\Mindbox\DTO\V3\Responses\CreditCardResponseDTO Mindbox\DTO\V3\Responses\PaymentResponseDTO::getCreditCard()

• Visibility: public

getBalanceType

\Mindbox\DTO\V3\Responses\BalanceTypeResponseDTO Mindbox\DTO\V3\Responses\PaymentResponseDTO::getBalanceType()

• Visibility: public

getType

string Mindbox\DTO\V3\PaymentDTO::getType()

• Visibility: public
• This method is defined by Mindbox\DTO\V3\PaymentDTO

getAmount

string Mindbox\DTO\V3\PaymentDTO::getAmount()

• Visibility: public
• This method is defined by Mindbox\DTO\V3\PaymentDTO

__construct

mixed Mindbox\DTO\DTO::__construct(array $data)

Конструктор DTO.

• Visibility: public
• This method is defined by Mindbox\DTO\DTO

Arguments

• $data array - <p>Массив данных.</p>

getDTOMap

array Mindbox\DTO\DTO::getDTOMap()

Геттер для $DTOMap.

• Visibility: public
• This method is static.
• This method is defined by Mindbox\DTO\DTO

makeDTO

mixed Mindbox\DTO\DTO::makeDTO(string $name, mixed $data)

Инициализация объекта DTO по его имени.

• Visibility: protected
• This method is static.
• This method is defined by Mindbox\DTO\DTO

Arguments

• $name string - <p>Имя класса DTO.</p>
• $data mixed - <p>Данные.</p>

getField

mixed Mindbox\DTO\DTO::getField(string $name, mixed $default)

Возвращает значение поля DTO по его имени.

• Visibility: public
• This method is defined by Mindbox\DTO\DTO

Arguments

• $name string - <p>Имя поля DTO.</p>
• $default mixed - <p>Значение по умолчанию, будет возвращено в случае, если такое поле отсутствует.</p>

setField

void Mindbox\DTO\DTO::setField(string $name, mixed $value)

Устанавливает в DTO поле с переданным названием.

• Visibility: public
• This method is defined by Mindbox\DTO\DTO

Arguments

• $name string - <p>Название.</p>
• $value mixed - <p>Значение.</p>

getFieldNames

array Mindbox\DTO\DTO::getFieldNames()

Возвращает список всех ключей массив полей DTO.

• Visibility: public
• This method is defined by Mindbox\DTO\DTO

all

array Mindbox\DTO\DTO::all()

Возвращает все поля DTO.

• Visibility: public
• This method is defined by Mindbox\DTO\DTO

toJson

string Mindbox\DTO\DTO::toJson(integer $options)

Возвращает все поля DTO в формате JSON.

• Visibility: public
• This method is defined by Mindbox\DTO\DTO

Arguments

• $options integer

unsetMetaInfo

array Mindbox\DTO\DTO::unsetMetaInfo(mixed $value)

Рекурсивно убирает из переданного массив мета-информацию.

• Visibility: private
• This method is defined by Mindbox\DTO\DTO

Arguments

• $value mixed - <p>Массив данных.</p>

toXML

string Mindbox\DTO\DTO::toXML()

Возвращает все поля DTO в формате XML.

• Visibility: public
• This method is defined by Mindbox\DTO\DTO

getXmlName

string Mindbox\DTO\DTO::getXmlName()

Геттер для $xmlName.

• Visibility: public
• This method is static.
• This method is defined by Mindbox\DTO\DTO

getFieldsAsArray

array Mindbox\DTO\DTO::getFieldsAsArray(boolean $unsetXmlMetaInfo)

Возвращает все поля DTO в виде массива.

• Visibility: public
• This method is defined by Mindbox\DTO\DTO

Arguments

• $unsetXmlMetaInfo boolean - <p>Флаг, сообщающий о том нужно ли очищать мета-информацию.</p>

count

integer Mindbox\DTO\DTO::count()

Возвращает количество элементов, модержащихся в DTO.

• Visibility: public
• This method is defined by Mindbox\DTO\DTO

getIterator

\ArrayIterator Mindbox\DTO\DTO::getIterator()

Возвращает ArrayIterator.

• Visibility: public
• This method is defined by Mindbox\DTO\DTO

offsetGet

mixed Mindbox\DTO\DTO::offsetGet(mixed $key)

Возвращает элемент DTO по заданному ключу.

• Visibility: public
• This method is defined by Mindbox\DTO\DTO

Arguments

• $key mixed - <p>Ключ.</p>

offsetExists

boolean Mindbox\DTO\DTO::offsetExists(mixed $key)

Проверяет, существует ли заданный ключ в элементах DTO.

• Visibility: public
• This method is defined by Mindbox\DTO\DTO

Arguments

• $key mixed

offsetSet

void Mindbox\DTO\DTO::offsetSet(mixed $key, mixed $value)

Устанавливает заданное значение по переданному ключу в элементы DTO.

• Visibility: public
• This method is defined by Mindbox\DTO\DTO

Arguments

• $key mixed
• $value mixed

offsetUnset

void Mindbox\DTO\DTO::offsetUnset(string $key)

Удаляет заданное значение из элементов DTO по ключу.

• Visibility: public
• This method is defined by Mindbox\DTO\DTO

Arguments

• $key string - <p>Ключ.</p>