Bitrix API

BasketItem extends BasketItemBase

Class BasketItem

Table of Contents

Constants

TYPE_SERVICE  = 2
TYPE_SET  = 1

Methods

canBuy()  : bool
changeCurrency()  : Result
Change basket item currency.
clearStartField()  : bool
create()  : BasketItemBase
createBundleCollection()  : BundleCollection
delete()  : Result
doFinalAction()  : Result
findItemByBasketCode()  : BasketItemBase|null
findItemById()  : BasketItemBase|null
findItemByXmlId()  : $this|null
formatQuantity()  : float|string
getAllFields()  : array<string|int, mixed>
getAvailableFields()  : array<string|int, mixed>
getAvailableFieldsMap()  : array<string|int, mixed>|null
getBasePrice()  : float
getBasePriceWithVat()  : float|int
getBasket()  : BasketBase
getBasketCode()  : int|null|string
getBundleBaseQuantity()  : array<string|int, mixed>|bool
getBundleCollection()  : BundleCollection|null
getCalculatedFields()  : array<string|int, mixed>
getCallbackFunction()  : null|string
getClassName()  : string
getCollection()  : EntityCollection
getCurrency()  : string
getCustomizableFields()  : array<string|int, mixed>
getDefaultPrice()  : float
getDiscountPrice()  : float
getField()  : float|string|null
getFieldsDescription()  : array<string|int, mixed>
getFieldValues()  : array<string|int, mixed>
getFinalPrice()  : float|int
getFUserId()  : float|null|string
getId()  : int
getInitialPrice()  : float|int
getInternalIndex()  : null|int
getMarkingCodeGroup()  : string
getNotPurchasedQuantity()  : float
getParentBasketItem()  : BasketItem|null
getParentBasketItemId()  : int|null|string
getPrice()  : float
getPriceWithVat()  : float|int
getProductId()  : int
getPropertyCollection()  : BasketPropertiesCollectionBase|null
getProvider()  : ProviderBase|null|string
getProviderEntity()  : bool|mixed|null
getProviderName()  : ProviderBase|null
getQuantity()  : float
getRegistryEntity()  : string|void
getRegistryType()  : string
getReservedQuantity()  : float
getReserveQuantityCollection()  : ReserveQuantityCollection|null
getSettableFields()  : array<string|int, mixed>
getSettableFieldsMap()  : array<string|int, mixed>|null
getVat()  : float|int
getVatRate()  : float|null
getVatUnit()  : float|int
getWeight()  : float|null|string
hasMeaningfulField()  : bool
initFields()  : mixed
isBarcodeMulti()  : bool
isBundleChild()  : bool
isBundleParent()  : bool
isChanged()  : bool
isClone()  : bool
isCustom()  : bool
isCustomPrice()  : bool
isDelay()  : bool
isExistPropertyCollection()  : bool
isMarkedFieldCustom()  : bool
isMathActionOnly()  : bool
isReservableItem()  : bool
isService()  : bool
isStartField()  : bool
isSupportedMarkingCode()  : bool
isVatInPrice()  : bool
load()  : BasketItem|mixed
markFieldCustom()  : mixed
save()  : Result
setCollection()  : mixed
setField()  : Result
setFields()  : Result
setMathActionOnly()  : bool
setOrderId()  : mixed
setPrice()  : Result
toArray()  : array<string|int, mixed>
unmarkFieldCustom()  : mixed
verify()  : Result

Constants

Methods

canBuy()

public canBuy() : bool
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
bool

changeCurrency()

Change basket item currency.

public changeCurrency(string $currency) : Result
Parameters
$currency : string
Return values
Result

createBundleCollection()

public createBundleCollection() : BundleCollection
Tags
throws
ArgumentOutOfRangeException
throws
Exception
Return values
BundleCollection

delete()

public delete() : Result
Tags
throws
ArgumentOutOfRangeException
throws
ObjectNotFoundException
throws
Exception
Return values
Result

doFinalAction()

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

findItemByBasketCode()

public findItemByBasketCode(mixed $basketCode) : BasketItemBase|null
Parameters
$basketCode : mixed
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
ArgumentTypeException
throws
NotImplementedException
throws
ObjectException
throws
ObjectNotFoundException
throws
Exception
Return values
BasketItemBase|null

findItemById()

public findItemById(mixed $id) : BasketItemBase|null
Parameters
$id : mixed
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
ArgumentTypeException
throws
NotImplementedException
throws
ObjectException
throws
ObjectNotFoundException
throws
Exception
Return values
BasketItemBase|null

findItemByXmlId()

public findItemByXmlId(mixed $xmlId) : $this|null
Parameters
$xmlId : mixed
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
$this|null

formatQuantity()

public static formatQuantity(mixed $quantity) : float|string
Parameters
$quantity : mixed
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
float|string

getAllFields()

public static getAllFields() : array<string|int, mixed>
Tags
throws
NotImplementedException
Return values
array<string|int, mixed>

getAvailableFields()

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

getAvailableFieldsMap()

public static getAvailableFieldsMap() : array<string|int, mixed>|null
Tags
throws
NotImplementedException
Return values
array<string|int, mixed>|null

getBasePrice()

public getBasePrice() : float
Tags
throws
ArgumentNullException
Return values
float

getBasePriceWithVat()

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

getBasketCode()

public getBasketCode() : int|null|string
Tags
throws
ArgumentNullException
Return values
int|null|string

getBundleBaseQuantity()

public getBundleBaseQuantity() : array<string|int, mixed>|bool
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
ArgumentTypeException
throws
NotImplementedException
throws
ObjectException
throws
ObjectNotFoundException
throws
Exception
Return values
array<string|int, mixed>|bool

getBundleCollection()

public getBundleCollection() : BundleCollection|null
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
ArgumentTypeException
throws
NotImplementedException
throws
ObjectException
throws
ObjectNotFoundException
throws
Exception
Return values
BundleCollection|null

getCalculatedFields()

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

getCallbackFunction()

public getCallbackFunction() : null|string
Tags
throws
ArgumentNullException
Return values
null|string

getClassName()

public static getClassName() : string
Return values
string

getCurrency()

public getCurrency() : string
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
string

getCustomizableFields()

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

getDefaultPrice()

public getDefaultPrice() : float
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
float

getDiscountPrice()

public getDiscountPrice() : float
Tags
throws
ArgumentNullException
Return values
float

getField()

public getField(mixed $name) : float|string|null
Parameters
$name : mixed
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
float|string|null

getFieldsDescription()

public static getFieldsDescription() : array<string|int, mixed>
Tags
throws
NotImplementedException
Return values
array<string|int, mixed>

getFieldValues()

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

getFinalPrice()

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

getFUserId()

public getFUserId() : float|null|string
Tags
throws
ArgumentNullException
Return values
float|null|string

getId()

public getId() : int
Return values
int

getInitialPrice()

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

getInternalIndex()

public getInternalIndex() : null|int
Return values
null|int

getMarkingCodeGroup()

public getMarkingCodeGroup() : string
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
string

getNotPurchasedQuantity()

public getNotPurchasedQuantity() : float
Return values
float

getParentBasketItemId()

public getParentBasketItemId() : int|null|string
Tags
throws
ArgumentNullException
Return values
int|null|string

getPrice()

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

getPriceWithVat()

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

getProvider()

public getProvider() : ProviderBase|null|string
Tags
throws
ArgumentNullException
throws
LoaderException
Return values
ProviderBase|null|string

getProviderEntity()

public getProviderEntity() : bool|mixed|null
Tags
throws
ArgumentNullException
throws
LoaderException
Return values
bool|mixed|null

getProviderName()

public getProviderName() : ProviderBase|null
Tags
throws
ArgumentNullException
Return values
ProviderBase|null

getQuantity()

public getQuantity() : float
Tags
throws
ArgumentNullException
Return values
float

getRegistryEntity()

public static getRegistryEntity() : string|void
Return values
string|void

getRegistryType()

public static getRegistryType() : string
Return values
string

getReservedQuantity()

public getReservedQuantity() : float
Tags
throws
ArgumentException
throws
ArgumentTypeException
throws
NotImplementedException
throws
SystemException
Return values
float

getReserveQuantityCollection()

public getReserveQuantityCollection() : ReserveQuantityCollection|null
Tags
throws
ArgumentException
throws
ArgumentTypeException
throws
NotImplementedException
throws
SystemException
Return values
ReserveQuantityCollection|null

getSettableFields()

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

getSettableFieldsMap()

public static getSettableFieldsMap() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getVat()

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

getVatRate()

public getVatRate() : float|null
Tags
throws
ArgumentNullException
Return values
float|null

getVatUnit()

public getVatUnit([bool $withRound = true ]) : float|int
Parameters
$withRound : bool = true
Tags
throws
ArgumentNullException
Return values
float|int

getWeight()

public getWeight() : float|null|string
Tags
throws
ArgumentNullException
Return values
float|null|string

initFields()

public initFields(array<string|int, mixed> $values) : mixed
Parameters
$values : array<string|int, mixed>
Tags
throws
ArgumentOutOfRangeException

isBarcodeMulti()

public isBarcodeMulti() : bool
Tags
throws
ArgumentNullException
Return values
bool

isBundleChild()

public isBundleChild() : bool
Return values
bool

isBundleParent()

public isBundleParent() : bool
Tags
throws
ArgumentNullException
Return values
bool

isChanged()

public isChanged() : bool
Return values
bool

isCustom()

public isCustom() : bool
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
bool

isCustomPrice()

public isCustomPrice() : bool
Tags
throws
ArgumentOutOfRangeException
Return values
bool

isDelay()

public isDelay() : bool
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
bool

isExistPropertyCollection()

public isExistPropertyCollection() : bool
Return values
bool

isMarkedFieldCustom()

public isMarkedFieldCustom(string $name) : bool
Parameters
$name : string
Return values
bool

isReservableItem()

public isReservableItem() : bool
Return values
bool

isService()

public isService() : bool
Return values
bool

isStartField()

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

isSupportedMarkingCode()

public isSupportedMarkingCode() : bool
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
bool

isVatInPrice()

public isVatInPrice() : bool
Tags
throws
ArgumentNullException
Return values
bool

markFieldCustom()

public markFieldCustom(string $name) : mixed
Parameters
$name : string
Tags
throws
ArgumentOutOfRangeException

save()

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

setField()

public setField(string $name, string|int|float $value) : Result
Parameters
$name : string

Field name.

$value : string|int|float

Field value.

Tags
throws
ArgumentOutOfRangeException
throws
Exception
Return values
Result

setFields()

public setFields(array<string|int, mixed> $fields) : Result
Parameters
$fields : array<string|int, mixed>
Tags
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
Exception
Return values
Result

setMathActionOnly()

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

setOrderId()

public setOrderId(mixed $id) : mixed
Parameters
$id : mixed
Tags
throws
ArgumentOutOfRangeException
throws
Exception

setPrice()

public setPrice(mixed $value[, bool $custom = false ]) : Result
Parameters
$value : mixed
$custom : bool = false
Tags
throws
ArgumentOutOfRangeException
throws
Exception
Return values
Result

toArray()

public toArray() : array<string|int, mixed>
Tags
throws
ArgumentException
throws
SystemException
Return values
array<string|int, mixed>

unmarkFieldCustom()

public unmarkFieldCustom(string $name) : mixed
Parameters
$name : string
Tags
throws
ArgumentOutOfRangeException

verify()

public verify() : Result
Tags
throws
ArgumentException
throws
NotImplementedException
throws
ObjectNotFoundException
Return values
Result 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results