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

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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Наверх