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

ShipmentCollection

\Bitrix\Sale\ShipmentCollection - класс коллекции отгрузок.


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

\Bitrix\Sale\ShipmentCollection > \Bitrix\Sale\Internals\EntityCollection > \Bitrix\Sale\Internals\CollectionBase
МетодОписание С версии
allowDelivery Разрешает доставку заказа. 15.5.0
calculateDelivery Рассчитывает стоимость доставки для каждой отгрузки. 15.5.0
createItem Создает новую отгрузку. 15.5.0
disallowDelivery Отменяет разрешение доставки заказа. 15.5.0
getBasePriceDelivery Возвращает стоимость доставки всех отгрузок без учета скидок и наценок. 15.5.0
getBasketItemDistributedQuantity Сбрасывает расчетную стоимость доставок.
getItemByShipmentCode Возвращает отгрузку по ее коду. 15.5.0
getOrder Возвращает заказ, к которому привязана коллекция. 15.5.0
getPriceDelivery Возвращает стоимость доставки всех отгрузок с учетом скидок и наценок. 15.5.0
getRegistryType Возвращает тип реестра, к которому относится объект. 18.0.0
getSystemShipment Возвращает системную отгрузку. 15.5.0
hasAllowDelivery Проверяет, есть ли у заказа отгрузки, у которых разрешена доставка. 16.5.0
hasShipped Проверяет, есть ли у заказа отгруженные отгрузки. 16.5.0
isAllowDelivery Проверяет, разрешена ли доставка заказа. 15.5.1
isExistBasketItem Проверяет, распределен ли товар по отгрузкам. 16.0.0
isMarked Проверяет, имеются ли отгрузки, которые отмечены как проблемные. 15.5.0
isReserved Проверяет, является ли заказ зарезервированным. 15.5.0
isShipped Проверяет, является ли заказ отгруженным. 15.5.0
load Возвращает заказ, к которому привязана коллекция. 18.0.0
refreshData Пересчитывает доставки для все отгрузок. 15.5.0
resetCollection Очищает коллекцию отгрузок. 15.5.1
resetData Сбрасывает расчетную стоимость доставок. 15.5.0
setOrder Привязывает заказ к коллекции. 15.5.0
verify Проверяет отгрузки на корректность. 16.0.0

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

МетодОписание С версии
clearCollectionУдаляет все элементы коллекции. 15.5.1
doFinalActionВыполняет финальные действия. 15.5.1
getIndexByIdИщет элемент в коллекции по ID и возвращает его внутренний индекс. 15.5.1
getItemByIdИщет элемент в коллекции по ID и возвращает его. 15.5.1
getItemByIndexИщет элемент в коллекции по внутреннему индексу и возвращает его. 17.5.0
isAnyItemDeletedПроверяет, был ли удален какой-либо элемент коллекции. 17.5.0
isChangedПроверяет, была ли изменена коллекция. Возвращает true или false. 15.5.2
isCloneПроверяет, является ли коллекция клонированной. Возвращает true или false. 6.0.26
verifyПроверяет коллекцию на корректность. Возвращает объект \Bitrix\Sale\Result. 17.5.0

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

МетодОписание С версии
countВозвращает количество элементов объекта. 15.5.3
currentВозвращает текущий элемент. 15.5.3
getIteratorВозвращает внешний итератор. 15.5.3
isEmptyПроверяет коллекцию на пустоту. Если в коллекции нет элементов, возвращается true (иначе false). 15.5.3
keyВозвращает индекс текущего элемента коллекции. 15.5.3
nextПеремещает указатель коллекции вперед на один элемент. 15.5.3
offsetExistsОпределяет, существует или нет заданное смещение (ключ). 15.5.3
offsetGetВозвращает заданное смещение (ключ). 15.5.3
offsetSetУстанавливает значения для данного смещения. 15.5.3
offsetUnsetСбрасывает значение по смещению. 15.5.3
rewindУстанавливает указатель на первый элемент коллекции. 15.5.3
validПроверяет, содержит ли коллекция еще элементы. 15.5.3


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

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

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

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

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