Skip to content

Mindbox-DTO-V2-Requests-OrderCreateRequestDTO.md

Latest commit

 

History

History
866 lines (308 loc) · 14.3 KB

Mindbox-DTO-V2-Requests-OrderCreateRequestDTO.md

File metadata and controls

866 lines (308 loc) · 14.3 KB

Mindbox\DTO\V2\Requests\OrderCreateRequestDTO

Class OrderCreateRequestDTO

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

$createdDateTimeUtc

public string $createdDateTimeUtc
  • Visibility: public

$preOrderDiscountedTotalPrice

public string $preOrderDiscountedTotalPrice
  • Visibility: public

$customer

public \Mindbox\DTO\V2\Requests\CustomerRequestDTO $customer

$discounts

public \Mindbox\DTO\V2\Requests\DiscountRequestCollection $discounts

$deliveryCost

public string $deliveryCost

$customFields

public array $customFields

$lines

public \Mindbox\DTO\V2\Requests\LineRequestCollection $lines

$payments

public \Mindbox\DTO\V2\Requests\PaymentRequestCollection $payments

$ids

public array $ids

$pointOfContact

public string $pointOfContact

$area

public string $area

Methods

getCreatedDateTimeUtc

string Mindbox\DTO\V2\Requests\OrderCreateRequestDTO::getCreatedDateTimeUtc()
  • Visibility: public

setCreatedDateTimeUtc

mixed Mindbox\DTO\V2\Requests\OrderCreateRequestDTO::setCreatedDateTimeUtc(mixed $createdDateTimeUtc)
  • Visibility: public

Arguments

  • $createdDateTimeUtc mixed

getPreOrderDiscountedTotalPrice

string Mindbox\DTO\V2\Requests\OrderCreateRequestDTO::getPreOrderDiscountedTotalPrice()
  • Visibility: public

setPreOrderDiscountedTotalPrice

mixed Mindbox\DTO\V2\Requests\OrderCreateRequestDTO::setPreOrderDiscountedTotalPrice(mixed $preOrderDiscountedTotalPrice)
  • Visibility: public

Arguments

  • $preOrderDiscountedTotalPrice mixed

setPointOfContact

mixed Mindbox\DTO\V2\Requests\OrderRequestDTO::setPointOfContact(mixed $pointOfContact)

Arguments

  • $pointOfContact mixed

setArea

mixed Mindbox\DTO\V2\Requests\OrderRequestDTO::setArea(mixed $area)

Arguments

  • $area mixed

getLines

\Mindbox\DTO\V2\Requests\LineRequestCollection Mindbox\DTO\V2\Requests\OrderRequestDTO::getLines()

setLines

mixed Mindbox\DTO\V2\Requests\OrderRequestDTO::setLines(array|\Mindbox\DTO\V2\Requests\LineRequestCollection $lines)

Arguments

getPayments

\Mindbox\DTO\V2\Requests\PaymentRequestCollection Mindbox\DTO\V2\Requests\OrderRequestDTO::getPayments()

setPayments

mixed Mindbox\DTO\V2\Requests\OrderRequestDTO::setPayments(array|\Mindbox\DTO\V2\Requests\PaymentRequestCollection $payments)

Arguments

getCustomer

\Mindbox\DTO\V2\Requests\CustomerRequestDTO Mindbox\DTO\V2\Requests\OrderRequestDTO::getCustomer()

setCustomer

mixed Mindbox\DTO\V2\Requests\OrderRequestDTO::setCustomer(array|\Mindbox\DTO\V2\Requests\CustomerRequestDTO $customer)

Arguments

getDiscounts

\Mindbox\DTO\V2\Requests\DiscountRequestCollection Mindbox\DTO\V2\Requests\OrderRequestDTO::getDiscounts()

setDiscounts

mixed Mindbox\DTO\V2\Requests\OrderRequestDTO::setDiscounts(array|\Mindbox\DTO\V2\Requests\DiscountRequestCollection $discounts)

Arguments

getDeliveryCost

string Mindbox\DTO\V2\Requests\OrderRequestDTO::getDeliveryCost()

setDeliveryCost

mixed Mindbox\DTO\V2\Requests\OrderRequestDTO::setDeliveryCost(mixed $deliveryCost)

Arguments

  • $deliveryCost mixed

setId

mixed Mindbox\DTO\V2\Requests\OrderRequestDTO::setId(string $name, mixed $value)

Arguments

  • $name string
  • $value mixed

setIds

mixed Mindbox\DTO\V2\Requests\OrderRequestDTO::setIds(array $ids)

Arguments

  • $ids array

setCustomField

mixed Mindbox\DTO\V2\Requests\OrderRequestDTO::setCustomField(mixed $name, mixed $value)

Arguments

  • $name mixed
  • $value mixed

setCustomFields

mixed Mindbox\DTO\V2\Requests\OrderRequestDTO::setCustomFields(array $fields)

Arguments

  • $fields array

getPointOfContact

string Mindbox\DTO\V2\OrderDTO::getPointOfContact()

getArea

string Mindbox\DTO\V2\OrderDTO::getArea()

getId

string|null Mindbox\DTO\V2\OrderDTO::getId(string $name)

Arguments

  • $name string

getIds

mixed Mindbox\DTO\V2\OrderDTO::getIds()

__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>