Документация для разработчиков
Темная тема

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


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх