Bitrix API

BasketItemCollection extends EntityCollection

AbstractYes

Class BasketItemCollection

Table of Contents

Methods

clearCollection()  : mixed
clearStartField()  : bool
count()  : int
Count elements of an object
createItem()  : BasketItemBase
current()  : mixed
Return the current element
doFinalAction()  : Result
getBasket()  : BasketBase
getBasketItems()  : array<string|int, mixed>
getContext()  : array<string|int, mixed>
getExistsItem()  : BasketItem|null
getExistsItems()  : array<string|int, BasketItem>
Get all basket items for need moduleId, productId and properties.
getIndexById()  : bool|int|null
getItemByBasketCode()  : BasketItemBase|null
getItemById()  : BasketItemBase|null
getItemByIndex()  : CollectableEntity|null
getItemByXmlId()  : BasketItemBase|null
getIterator()  : ArrayIterator
getOrder()  : OrderBase
getOrderId()  : int
getRegistryType()  : string
hasMeaningfulField()  : bool
isAnyItemAdded()  : bool
isAnyItemDeleted()  : bool
isChanged()  : bool
isClone()  : bool
isEmpty()  : bool
Checks if collection is empty.
isMathActionOnly()  : bool
isStartField()  : bool
key()  : mixed
Return the key of the current element
loadFromArray()  : mixed
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
rewind()  : mixed
Rewind the Iterator to the first element
setMathActionOnly()  : bool
toArray()  : mixed
valid()  : mixed
Checks if current position is valid
verify()  : Result

Methods

clearCollection()

public clearCollection() : mixed
Tags
throws
ArgumentOutOfRangeException
throws
ObjectNotFoundException

count()

Count elements of an object

public count() : int
Return values
int

createItem()

public createItem(mixed $moduleId, mixed $productId[, null $basketCode = null ]) : BasketItemBase
Parameters
$moduleId : mixed
$productId : mixed
$basketCode : null = null
Tags
throws
NotImplementedException
throws
ArgumentException
throws
ArgumentTypeException
Return values
BasketItemBase

doFinalAction()

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

getBasketItems()

public getBasketItems() : array<string|int, mixed>
Return values
array<string|int, mixed>

getExistsItem()

public getExistsItem(mixed $moduleId, mixed $productId[, array<string|int, mixed> $properties = array() ]) : BasketItem|null

the basket can contain duplicate items. Use method getExistsItems

Get first basket item for need moduleId, productId and properties

Parameters
$moduleId : mixed
$productId : mixed
$properties : array<string|int, mixed> = array()
Tags
throws
NotImplementedException
throws
ArgumentException
throws
ArgumentNullException
Return values
BasketItem|null

getExistsItems()

Get all basket items for need moduleId, productId and properties.

public getExistsItems(string $moduleId, int $productId[, array<string|int, mixed>|null $properties = [] ]) : array<string|int, BasketItem>
Parameters
$moduleId : string
$productId : int
$properties : array<string|int, mixed>|null = []

if NULL - skips checking properties, even if they are setted in the parameters and/or the basket item.

Return values
array<string|int, BasketItem>

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

getRegistryType()

public static getRegistryType() : string
Tags
throws
NotImplementedException
Return values
string

hasMeaningfulField()

public hasMeaningfulField() : bool
Return values
bool

isEmpty()

Checks if collection is empty.

public isEmpty() : 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

loadFromArray()

public loadFromArray(array<string|int, mixed> $itemList) : mixed
Parameters
$itemList : array<string|int, 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

rewind()

Rewind the Iterator to the first element

public rewind() : mixed

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