Documentation

ShipmentCollection

\Bitrix\Sale\ShipmentCollection class for collection of shipments


Inheritance chain

\Bitrix\Sale\ShipmentCollection > \Bitrix\Sale\Internals\EntityCollection > \Bitrix\Sale\Internals\CollectionBase
MethodDescription Available from version
allowDelivery Allows order delivery.
calculateDelivery Calculates delivery cost for an individual shipment.
createItem Creates a new shipment.
disallowDelivery Denies order delivery.
getBasePriceDelivery Returns delivery cost for all shipments without discounts and extra charges.
getBasketItemDistributedQuantity Resets estimated cost for deliveries.
getItemByShipmentCode Returns shipment by its code.
getOrder Returns order with associated collection.
getPriceDelivery Returns delivery cost for all shipments with discounts and extra charges.
getRegistryType Returns register type for an object.
getSystemShipment Returns a system shipment.
hasAllowDelivery Checks if order has shipments with allowed delivery.
hasShipped Checks if order has shipments that were shipped.
isAllowDelivery Checks if shipment delivery is allowed.
isExistBasketItem Checks if product is distributed by shipments.
isMarked Checks for existing shipments marked as containing errors.
isReserved Checks if order is reserved.
isShipped Checks if order was shipped.
load Returns order with associated collection.
refreshData Recalculates deliveries for all shipments.
resetCollection Clears collection of shipments.
resetData Resets estimated delivery cost.
setOrder Associates order to a collection.
verify Verifies shipments.

Methods for parent class \Bitrix\Sale\Internals\EntityCollection

MethodDescription Available from version
clearCollectionDeletes all collection items.
doFinalActionExecutes final actions.
getIndexByIdSearches item in collection by ID and returns its internal index.
getItemByIdSearches item in collection by ID and returns it.
getItemByIndexSearches item in collection by internal index and returns it.
isAnyItemDeletedChecks if a collection item was deleted.
isChangedChecks if collection was updated. Returns true or false.
isCloneChecks if collection was cloned. Returns true or false.
verifyVerifies collection validly. Returns object \Bitrix\Sale\Result.

Methods for parent class \Bitrix\Sale\Internals\CollectionBase

MethodDescription Available from version
countReturns number of object items.
currentReturns current item.
getIteratorReturns external iterator.
isEmptyChecks collection for emptiness. When collection doesn't contain any items, returns true (otherwise, false).
keyReturns index for current collection item.
nextMoves collection selection to the next item.
offsetExistsDefines, if specified offset exists (key).
offsetGetReturns specified offset (key).
offsetSetSets value for this offset.
offsetUnsetResets offset value.
rewindRewinds selection to the first collection item.
validChecks, if collection contains valid items.


© «Bitrix24», 2001-2022
Up