Skip to content

Mindbox-DTO-V2-Requests-LineRequestDTO.md

Latest commit

 

History

History
600 lines (217 loc) · 8.97 KB

Mindbox-DTO-V2-Requests-LineRequestDTO.md

File metadata and controls

600 lines (217 loc) · 8.97 KB
Raw

Mindbox\DTO\V2\Requests\LineRequestDTO

Class LineRequestDTO

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

$giftCard

public \Mindbox\DTO\V2\Requests\GiftCardRequestDTO $giftCard
  • Visibility: public

$discounts

public \Mindbox\DTO\V2\Requests\DiscountRequestCollection $discounts
  • Visibility: public

$quantity

public string $quantity

$customFields

public array $customFields

$status

public string $status

Methods

setQuantity

mixed Mindbox\DTO\V2\Requests\LineRequestDTO::setQuantity(mixed $quantity)
  • Visibility: public

Arguments

  • $quantity mixed

setStatus

mixed Mindbox\DTO\V2\Requests\LineRequestDTO::setStatus(mixed $status)
  • Visibility: public

Arguments

  • $status mixed

getGiftCard

\Mindbox\DTO\V2\Requests\GiftCardRequestDTO Mindbox\DTO\V2\Requests\LineRequestDTO::getGiftCard()
  • Visibility: public

setGiftCard

mixed Mindbox\DTO\V2\Requests\LineRequestDTO::setGiftCard(array|\Mindbox\DTO\V2\Requests\GiftCardRequestDTO $giftCard)
  • Visibility: public

Arguments

getDiscounts

\Mindbox\DTO\V2\Requests\DiscountRequestCollection Mindbox\DTO\V2\Requests\LineRequestDTO::getDiscounts()
  • Visibility: public

setDiscounts

mixed Mindbox\DTO\V2\Requests\LineRequestDTO::setDiscounts(array|\Mindbox\DTO\V2\Requests\DiscountRequestCollection $discounts)
  • Visibility: public

Arguments

setCustomField

mixed Mindbox\DTO\V2\Requests\LineRequestDTO::setCustomField(mixed $name, mixed $value)
  • Visibility: public

Arguments

  • $name mixed
  • $value mixed

setCustomFields

mixed Mindbox\DTO\V2\Requests\LineRequestDTO::setCustomFields(array $fields)
  • Visibility: public

Arguments

  • $fields array

getQuantity

string Mindbox\DTO\V2\LineDTO::getQuantity()

getStatus

string Mindbox\DTO\V2\LineDTO::getStatus()

getCustomField

string|null Mindbox\DTO\V2\LineDTO::getCustomField(string $name)

Arguments

  • $name string

getCustomFields

mixed Mindbox\DTO\V2\LineDTO::getCustomFields()

__construct

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

Конструктор 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 по его имени.

Arguments

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

setField

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

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

Arguments

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

getFieldNames

array Mindbox\DTO\DTO::getFieldNames()

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

all

array Mindbox\DTO\DTO::all()

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

toJson

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

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

Arguments

  • $options integer

unsetMetaInfo

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

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

Arguments

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

toXML

string Mindbox\DTO\DTO::toXML()

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

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 в виде массива.

Arguments

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

count

integer Mindbox\DTO\DTO::count()

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

getIterator

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

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

offsetGet

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

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

Arguments

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

offsetExists

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

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

Arguments

  • $key mixed

offsetSet

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

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

Arguments

  • $key mixed
  • $value mixed

offsetUnset

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

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

Arguments

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