Bitrix API

ShipmentCollection extends EntityCollection

Class ShipmentCollection

Table of Contents

Methods

allowDelivery()  : Result
Resolution fact shipment to shipment collection
calculateDelivery()  : Result
canAutoFixError()  : string
clearCollection()  : mixed
clearStartField()  : bool
count()  : int
Count elements of an object
createItem()  : mixed
Create new shipment
current()  : mixed
Return the current element
disallowDelivery()  : Result
Prohibition upon shipment to shipment collection
doFinalAction()  : Result
getBasePriceDelivery()  : float
getBasketItemDistributedQuantity()  : float|int
getBasketItemShippedQuantity()  : float|int
getErrorEntity()  : string
getIndexById()  : bool|int|null
getItemById()  : CollectableEntity|null
getItemByIndex()  : CollectableEntity|null
getItemByShipmentCode()  : Shipment|null
getIterator()  : ArrayIterator
getList()  : Result
getNotSystemItems()  : CollectionFilterIterator
getOrder()  : Order
Getting entity of the order
getPriceDelivery()  : float
getRegistryType()  : string
getSystemShipment()  : Shipment
Getting the system shipment
hasAllowDelivery()  : bool
hasMeaningfulField()  : bool
hasShipped()  : bool
Is the entire collection shipped
isAllowDelivery()  : bool
Is the entire collection allowed for shipment
isAnyItemAdded()  : bool
isAnyItemDeleted()  : bool
isChanged()  : bool
isClone()  : bool
isEmpty()  : bool
Checks if collection is empty.
isEmptySystemShipment()  : bool
Is the a system shipped empty
isExistBasketItem()  : bool
isExistsSystemShipment()  : bool
Check whether there is a system collection of shipping
isMarked()  : bool
Is the entire collection of marked
isMathActionOnly()  : bool
isReserved()  : bool
Is the entire collection reserved
isShipped()  : bool
Is the entire collection shipped
isStartField()  : bool
key()  : mixed
Return the key of the current element
load()  : ShipmentCollection
Loaded from the database collection shipments Order
next()  : mixed
Move forward to next element
offsetExists()  : bool
Whether a offset exists
offsetGet()  : mixed
Offset to retrieve
offsetSet()  : void
Offset to set
offsetUnset()  : void
Offset to unset
onBasketModify()  : Result
onItemModify()  : Result
Processing changes the essence of the shipment fields
onOrderModify()  : Result
refreshData()  : Result
resetData()  : mixed
rewind()  : mixed
Rewind the Iterator to the first element
save()  : Result
Saving data collection
setMathActionOnly()  : bool
setOrder()  : mixed
The attachment order to the collection
toArray()  : mixed
tryReserve()  : Result
Trying to reserve the contents of the shipment collection
tryUnreserve()  : Result
Trying to reserve the contents of the shipment collection
updateReservedFlag()  : Result
valid()  : mixed
Checks if current position is valid
verify()  : Result

Methods

allowDelivery()

Resolution fact shipment to shipment collection

public allowDelivery() : Result
Return values
Result

canAutoFixError()

public canAutoFixError(mixed $value) : string
Parameters
$value : mixed
Return values
string

clearCollection()

public clearCollection() : mixed
Tags
throws
ArgumentOutOfRangeException
throws
ObjectNotFoundException

count()

Count elements of an object

public count() : int
Return values
int

createItem()

Create new shipment

public createItem([Base|null $delivery = null ]) : mixed
Parameters
$delivery : Base|null = null
Tags
throws
ArgumentException
throws
ObjectNotFoundException

disallowDelivery()

Prohibition upon shipment to shipment collection

public disallowDelivery() : Result
Return values
Result

doFinalAction()

public doFinalAction([bool $hasMeaningfulField = false ]) : Result
Parameters
$hasMeaningfulField : bool = false
Return values
Result

getBasePriceDelivery()

public getBasePriceDelivery() : float
Return values
float

getBasketItemDistributedQuantity()

public getBasketItemDistributedQuantity(BasketItem $basketItem) : float|int
Parameters
$basketItem : BasketItem
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ObjectNotFoundException
Return values
float|int

getBasketItemShippedQuantity()

public getBasketItemShippedQuantity(BasketItem $basketItem) : float|int
Parameters
$basketItem : BasketItem
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ObjectNotFoundException
Return values
float|int

getErrorEntity()

public getErrorEntity(mixed $value) : string
Parameters
$value : mixed
Return values
string

getIndexById()

public getIndexById(mixed $id) : bool|int|null
Parameters
$id : mixed
Tags
throws
ArgumentNullException
Return values
bool|int|null

getIterator()

public getIterator() : ArrayIterator
Return values
ArrayIterator

getList()

public static getList([array<string|int, mixed> $parameters = array() ]) : Result
Parameters
$parameters : array<string|int, mixed> = array()
Return values
Result

getRegistryType()

public static getRegistryType() : string
Return values
string

hasMeaningfulField()

public hasMeaningfulField() : bool
Return values
bool

hasShipped()

Is the entire collection shipped

public hasShipped() : bool
Return values
bool

isAllowDelivery()

Is the entire collection allowed for shipment

public isAllowDelivery() : bool
Return values
bool

isEmpty()

Checks if collection is empty.

public isEmpty() : bool
Return values
bool

isEmptySystemShipment()

Is the a system shipped empty

public isEmptySystemShipment() : bool
Return values
bool

isExistBasketItem()

public isExistBasketItem(BasketItem $basketItem[, bool|false $includeSystemShipment = false ]) : bool
Parameters
$basketItem : BasketItem
$includeSystemShipment : bool|false = false
Tags
throws
ObjectNotFoundException
Return values
bool

isExistsSystemShipment()

Check whether there is a system collection of shipping

public isExistsSystemShipment() : bool
Return values
bool

isMarked()

Is the entire collection of marked

public isMarked() : bool
Return values
bool

isReserved()

Is the entire collection reserved

public isReserved() : bool
Return values
bool

isShipped()

Is the entire collection shipped

public isShipped() : bool
Return values
bool

isStartField()

public isStartField([bool $isMeaningfulField = false ]) : bool
Parameters
$isMeaningfulField : bool = false
Return values
bool

key()

Return the key of the current element

public key() : mixed

offsetExists()

Whether a offset exists

public offsetExists(mixed $offset) : bool
Parameters
$offset : mixed
Return values
bool

offsetGet()

Offset to retrieve

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Attributes
#[ReturnTypeWillChange]

offsetSet()

Offset to set

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed

offsetUnset()

Offset to unset

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed

onBasketModify()

public onBasketModify(mixed $action, BasketItemBase $basketItem[, null $name = null ][, null $oldValue = null ][, null $value = null ]) : Result
Parameters
$action : mixed
$basketItem : BasketItemBase
$name : null = null
$oldValue : null = null
$value : null = null
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
ObjectNotFoundException
throws
SystemException
Return values
Result

onItemModify()

Processing changes the essence of the shipment fields

public onItemModify(CollectableEntity $item[, null $name = null ][, null $oldValue = null ][, null $value = null ]) : Result
Parameters
$item : CollectableEntity
$name : null = null
$oldValue : null = null
$value : null = null
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
NotImplementedException
throws
NotSupportedException
throws
ObjectException
throws
ObjectNotFoundException
Return values
Result

onOrderModify()

public onOrderModify(mixed $name, mixed $oldValue, mixed $value) : Result
Parameters
$name : mixed
$oldValue : mixed
$value : mixed
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
ObjectNotFoundException
Return values
Result

refreshData()

public refreshData() : Result
Tags
throws
NotSupportedException
Return values
Result

rewind()

Rewind the Iterator to the first element

public rewind() : mixed

save()

Saving data collection

public save() : Result
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ObjectNotFoundException
Return values
Result

setMathActionOnly()

public setMathActionOnly([bool|false $value = false ]) : bool
Parameters
$value : bool|false = false
Return values
bool

tryReserve()

Trying to reserve the contents of the shipment collection

public tryReserve() : Result
Return values
Result

tryUnreserve()

Trying to reserve the contents of the shipment collection

public tryUnreserve() : Result
Tags
throws
ArgumentException
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
ObjectNotFoundException
Return values
Result

valid()

Checks if current position is valid

public valid() : mixed

verify()

public verify() : Result
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
ObjectNotFoundException
Return values
Result 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results