Skip to content

Latest commit

 

History

History
409 lines (157 loc) · 6.34 KB

Mindbox-DTO-V3-ProductListItemDTO.md

File metadata and controls

409 lines (157 loc) · 6.34 KB

Mindbox\DTO\V3\ProductListItemDTO

Class ProductListItemDTO

  • Class name: ProductListItemDTO
  • Namespace: Mindbox\DTO\V3
  • This is an abstract class
  • Parent class: Mindbox\DTO\DTO

Constants

XML_ITEM_NAME_INDEX

const XML_ITEM_NAME_INDEX = '@itemName'

Properties

$xmlName

protected string $xmlName = 'dto'
  • Visibility: protected
  • This property is static.

$DTOMap

protected array $DTOMap = array()
  • Visibility: protected
  • This property is static.

$items

protected array $items = array()
  • Visibility: protected

$count

public string $count
  • Visibility: public

$price

public string $price
  • Visibility: public

Methods

getCount

string Mindbox\DTO\V3\ProductListItemDTO::getCount()
  • Visibility: public

getPrice

string Mindbox\DTO\V3\ProductListItemDTO::getPrice()
  • Visibility: public

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