ShipmentItem

Описание и методы

\Bitrix\Sale\ShipmentItem – класс элемента отгрузки. Класс также реализует интерфейс \IEntityMarker.

Цепочка наследования

\Bitrix\Sale\ShipmentItem > \Bitrix\Sale\Internals\CollectableEntity > \Bitrix\Sale\Internals\Entity

Методы класса

Метод	Описание	С версии
create	Создает объект элемента отгрузки и привязывает к нему коллекцию.	15.5.0
getBasketCode	Возвращает код товара.	15.5.0
getBasketId	Возвращает ID товара.	15.5.0
getBasketItem	Возвращает объект товара.	15.5.0
getProductId	Возвращает `PRODUCT_ID` товара.	17.5.1
getQuantity	Возвращает количество товара в отгрузке.	15.5.0
getRegistryType	Возвращает тип реестра, к которому относится объект.	18.0.0
getReservedQuantity	Возвращает зарезервированное количество товара в отгрузке.	15.5.0
getShipmentItemStoreCollection	Возвращает склады, по которым распределен товар для отгрузки.	15.5.0
isChanged	Проверяет, был ли изменен объект.	15.5.2
loadForShipment	Возвращает товары в отгрузке по ее ID.	15.5.0
setQuantity	Устанавливает товара количество в отгрузке.	15.5.0
verify	Проверяет товар в отгрузке на корректность.	16.0.22

Методы родительского класса \Bitrix\Sale\Internals\CollectableEntity

Метод	Описание	С версии
createClone	Клонирует данный элемент.	17.5.0
delete	Удаляет элемент.	15.5.1
doFinalAction	Выполняет финальные действия.	15.5.1
getCollection	Возвращает коллекцию, к которой привязан элемент.	15.5.1
getInternalIndex	Возвращает внутренний индекс элемента в коллекции.	15.5.1
isClone	Проверяет, является ли данный элемент клоном.	16.0.26
setCollection	Привязывает коллекцию к элементу.	15.5.1

Методы родительского класса \Bitrix\Sale\Internals\Entity

Метод	Описание	С версии
doFinalAction	Абстрактный метод, предназначенный для реализации логики "конечных" расчетов.	15.5.0
getAvailableFields	Возвращает массив полей, которые могут быть установлены через методы `setField()` и `setFields()`.	15.5.0
getAvailableFieldsMap	Возвращает массив полей, которые могут быть установлены через методы `setField()` и `setFields()`. В качестве ключей массива выступают значения getAvailableFields.	17.5.0
getField	Возвращает значение поля `$name`.	18.0.3
getFieldValues	Возвращает массив полей со значениями.	15.5.0
getId	Возвращает идентификатор сущности.	15.5.0
initField	Инициализирует поле значением. При этом объект не считается измененным.	15.5.0
initFields	Инициализирует поля значениями. При этом объект не считается измененным.	15.5.0
isChanged	Проверяет, была ли изменена сущность. Если да, то возвращает `true`, иначе `false`.	15.5.2
isMathActionOnly	Проверяет, идет ли расчет на текущих данных (данные из провайдера не запрашиваются). Если да, то возвращает `true`, иначе `false`.	15.5.0
setField	Устанавливает значение поля `$name`.	15.5.0
setFields	Инициализирует поля значениями. При этом объект не считается измененным.	15.5.0
setMathActionOnly	Отключает запросы к провайдеру при выполнении расчетов.	15.5.0
verify	Проверяет, корректен ли объект. Возвращает объект `\Bitrix\Sale\Result`.	16.0.0