Bitrix API

ShipmentItem extends CollectableEntity implements IEntityMarker

Class CollectableEntity

Table of Contents

Interfaces

IEntityMarker
Bitrix Framework

Methods

canAutoFixError()  : bool
canMarked()  : bool
checkMarkingCodeOnDeducted()  : Result
clearStartField()  : bool
delete()  : mixed
Deletes shipment item
doFinalAction()  : Result
getAllFields()  : array<string|int, mixed>
getAutoFixErrorsList()  : array<string|int, mixed>
getAvailableFields()  : array<string|int, mixed>
getAvailableFieldsMap()  : array<string|int, mixed>|null
getBasketCode()  : int
getBasketId()  : int
getBasketItem()  : BasketItem
getClassName()  : string
getCollection()  : ShipmentItemCollection
getCustomizableFields()  : array<string|int, mixed>
getErrorEntity()  : string
getField()  : string|null
getFieldsDescription()  : array<string|int, mixed>
getFieldValues()  : array<string|int, mixed>
getId()  : int
getInternalIndex()  : null|int
getList()  : Result
getMarkField()  : string
getNeedReserveQuantity()  : int
getProductId()  : int
getQuantity()  : float
getRegistryEntity()  : string
getRegistryType()  : string
getReservedQuantity()  : float
getShipmentItemStoreCollection()  : ShipmentItemStoreCollection|null
hasMeaningfulField()  : bool
isChanged()  : bool
isClone()  : bool
isMarkedFieldCustom()  : bool
isMathActionOnly()  : bool
isShippable()  : bool
Returns true if basketItem can be shipped
isStartField()  : bool
loadForShipment()  : array<string|int, mixed>
markFieldCustom()  : mixed
needReserve()  : bool
onBasketModify()  : Result
setCollection()  : mixed
setField()  : Result
setFieldNoDemand()  : mixed
setFields()  : Result
setMathActionOnly()  : bool
setQuantity()  : Result
toArray()  : array<string|int, mixed>
tryFixError()  : Result
tryReserve()  : mixed
tryUnreserve()  : mixed
unmarkFieldCustom()  : mixed
verify()  : Result

Methods

canAutoFixError()

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

canMarked()

public canMarked() : bool
Return values
bool

checkMarkingCodeOnDeducted()

public checkMarkingCodeOnDeducted() : Result
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
Return values
Result

delete()

Deletes shipment item

public delete() : mixed
Tags
throws
ArgumentOutOfRangeException
throws
Exception

doFinalAction()

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

getAllFields()

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

getAutoFixErrorsList()

public getAutoFixErrorsList() : array<string|int, mixed>
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

getBasketCode()

public getBasketCode() : int
Tags
throws
SystemException
Return values
int

getBasketId()

public getBasketId() : int
Return values
int

getClassName()

public static getClassName() : string
Return values
string

getCustomizableFields()

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

getErrorEntity()

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

getField()

public getField(mixed $name) : string|null
Parameters
$name : mixed
Return values
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>

getId()

public getId() : int
Return values
int

getInternalIndex()

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

getList()

public static getList(array<string|int, mixed> $parameters) : Result
Parameters
$parameters : array<string|int, mixed>
Tags
throws
ArgumentException
Return values
Result

getMarkField()

public getMarkField() : string
Return values
string

getNeedReserveQuantity()

public getNeedReserveQuantity() : int
Tags
throws
ObjectNotFoundException
Return values
int

getProductId()

public getProductId() : int
Tags
throws
SystemException
Return values
int

getQuantity()

public getQuantity() : float
Return values
float

getRegistryEntity()

public static getRegistryEntity() : string
Return values
string

getRegistryType()

public static getRegistryType() : string
Return values
string

getReservedQuantity()

public getReservedQuantity() : float
Return values
float

isChanged()

public isChanged() : bool
Return values
bool

isMarkedFieldCustom()

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

isShippable()

Returns true if basketItem can be shipped

public isShippable() : bool
Return values
bool

isStartField()

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

loadForShipment()

public static loadForShipment(mixed $id) : array<string|int, mixed>
Parameters
$id : mixed
Tags
throws
ArgumentException
throws
ArgumentNullException
Return values
array<string|int, mixed>

markFieldCustom()

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

needReserve()

public needReserve() : bool
Tags
throws
ArgumentOutOfRangeException
throws
ObjectNotFoundException
Return values
bool

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

setField()

public setField(mixed $name, mixed $value) : Result
Parameters
$name : mixed
$value : mixed
Return values
Result

setFieldNoDemand()

public setFieldNoDemand(mixed $name, mixed $value) : mixed
Parameters
$name : mixed
$value : mixed

setFields()

public setFields(array<string|int, mixed> $values) : Result
Parameters
$values : 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

setQuantity()

public setQuantity(float $quantity) : Result
Parameters
$quantity : float
Tags
throws
ArgumentOutOfRangeException
throws
Exception
Return values
Result

toArray()

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

tryFixError()

public tryFixError(mixed $code) : Result
Parameters
$code : mixed
Return values
Result

tryReserve()

public tryReserve() : mixed
Tags
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
Exception

tryUnreserve()

public tryUnreserve() : mixed
Tags
throws
ArgumentOutOfRangeException
throws
NotSupportedException
throws
Exception

unmarkFieldCustom()

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

verify()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results