Bitrix API

ShipmentItemCollection extends EntityCollection

Class EntityCollection

Table of Contents

Methods

canAutoFixError()  : string
clearCollection()  : mixed
clearStartField()  : bool
count()  : int
Count elements of an object
createItem()  : ShipmentItem|null
current()  : mixed
Return the current element
deleteByBasketItem()  : Result
doFinalAction()  : Result
getBasketItemQuantity()  : float|int
getErrorEntity()  : string
getIndexById()  : bool|int|null
getItemByBasketCode()  : ShipmentItem|null
getItemByBasketId()  : ShipmentItem|null
getItemById()  : CollectableEntity|null
getItemByIndex()  : CollectableEntity|null
getIterator()  : ArrayIterator
getList()  : Result
getPrice()  : float|int
getRegistryType()  : string
getSellableItems()  : CollectionFilterIterator
getShipment()  : Shipment
getShippableItems()  : CollectionFilterIterator
Returns shippable items
getWeight()  : float
hasMeaningfulField()  : bool
isAnyItemAdded()  : bool
isAnyItemDeleted()  : bool
isChanged()  : bool
isClone()  : bool
isEmpty()  : bool
Checks if collection is empty.
isExistBasketItem()  : bool
isMathActionOnly()  : bool
isStartField()  : bool
key()  : mixed
Return the key of the current element
load()  : ShipmentItemCollection
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
onBeforeBasketItemDelete()  : Result
onItemModify()  : Result
resetCollection()  : mixed
rewind()  : mixed
Rewind the Iterator to the first element
save()  : Result
setMathActionOnly()  : bool
toArray()  : mixed
valid()  : mixed
Checks if current position is valid
verify()  : Result

Methods

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

deleteByBasketItem()

public deleteByBasketItem(BasketItem $basketItem) : Result
Parameters
$basketItem : BasketItem
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
ObjectNotFoundException
throws
SystemException
Return values
Result

doFinalAction()

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

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()
Tags
throws
ArgumentException
Return values
Result

getPrice()

public getPrice() : float|int
Tags
throws
ArgumentNullException
Return values
float|int

hasMeaningfulField()

public hasMeaningfulField() : 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, BasketItem $basketItem[, null $name = null ][, null $oldValue = null ][, null $value = null ]) : Result
Parameters
$action : mixed
$basketItem : BasketItem
$name : null = null
$oldValue : null = null
$value : null = null
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
ObjectNotFoundException
throws
SystemException
Return values
Result

onBeforeBasketItemDelete()

public onBeforeBasketItemDelete(BasketItem $basketItem) : Result
Parameters
$basketItem : BasketItem
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
ObjectNotFoundException
throws
SystemException
Return values
Result

onItemModify()

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
NotSupportedException
throws
SystemException
Return values
Result

resetCollection()

public resetCollection(Basket $basket) : mixed
Parameters
$basket : Basket
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
ArgumentTypeException
throws
NotSupportedException
throws
ObjectNotFoundException

rewind()

Rewind the Iterator to the first element

public rewind() : mixed

save()

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

setMathActionOnly()

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

valid()

Checks if current position is valid

public valid() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results