Bitrix API

OrderCompatibility extends EntityCompatibility

Class OrderCompatibility

Table of Contents

Constants

ENTITY_ORDER  = 'ORDER'
ENTITY_ORDER_TABLE  = 'b_sale_order'
ENTITY_PAYMENT  = 'PAYMENT'
ENTITY_PAYMENT_TABLE  = 'b_sale_order_payment'
ORDER_COMPAT_ACTION_ADD  = 'ADD'
ORDER_COMPAT_ACTION_SAVE  = 'SAVE'
ORDER_COMPAT_ACTION_UPDATE  = 'UPDATE'

Methods

add()  : Result
allowDelivery()  : Result
backRawField()  : array<string|int, mixed>
cancel()  : Result
Cancel order
canPayWithUserBudget()  : bool
convertDateFieldsToOldFormat()  : array<string|int, mixed>
Convert an array of dates from the object to a string
create()  : static
createShipmentFromShipmentSystem()  : Shipment
delete()  : Result
Delete the order
execute()  : CDBResult|int
getById()  : CDBResult|int
getField()  : null|string
getFieldValues()  : array<string|int, mixed>
getList()  : CDBResult
getOrder()  : Order|null
getOrderFields()  : Result
getRequestFields()  : array<string|int, mixed>
isExistPrice()  : mixed
parseField()  : null|string
pay()  : Result
payFromBudget()  : Result
Paid from internal account
reserve()  : Result
saveRawFields()  : Result
setBasketCompatibility()  : mixed
setCallback()  : mixed
setField()  : mixed
setFields()  : mixed
setFilter()  : mixed
setGroup()  : mixed
setNav()  : mixed
setSelect()  : mixed
setSort()  : mixed
shipment()  : Result
update()  : Result

Constants

Methods

add()

public static add(array<string|int, mixed> $fields) : Result
Parameters
$fields : array<string|int, mixed>
Return values
Result

allowDelivery()

public static allowDelivery(mixed $id, bool $value) : Result
Parameters
$id : mixed
$value : bool
Tags
throws
ObjectNotFoundException
throws
ArgumentNullException
throws
NotSupportedException
Return values
Result

backRawField()

public static backRawField(mixed $entityName, array<string|int, mixed> $fields[, string $separator = '=' ]) : array<string|int, mixed>
Parameters
$entityName : mixed
$fields : array<string|int, mixed>
$separator : string = '='
Tags
throws
ArgumentOutOfRangeException
Return values
array<string|int, mixed>

cancel()

Cancel order

public static cancel(int $orderId, string $value[, bool|string $comment = false ]) : Result
Parameters
$orderId : int

Order ID.

$value : string

The cancel key(Y/N).

$comment : bool|string = false

cancel reason

Tags
throws
ArgumentNullException
Return values
Result

canPayWithUserBudget()

public static canPayWithUserBudget(float $needSum, int $userId, string $currency[, bool $fullPay = true ]) : bool
Parameters
$needSum : float
$userId : int
$currency : string
$fullPay : bool = true
Return values
bool

convertDateFieldsToOldFormat()

Convert an array of dates from the object to a string

public static convertDateFieldsToOldFormat(array<string|int, mixed> $fields) : array<string|int, mixed>
Parameters
$fields : array<string|int, mixed>

The array of dates

Return values
array<string|int, mixed>

create()

public static create(array<string|int, mixed> $fields) : static
Parameters
$fields : array<string|int, mixed>
Return values
static

createShipmentFromShipmentSystem()

public static createShipmentFromShipmentSystem(ShipmentCollection $shipmentCollection) : Shipment
Parameters
$shipmentCollection : ShipmentCollection
Tags
throws
ArgumentNullException
Return values
Shipment

delete()

Delete the order

public static delete(int $id) : Result
Parameters
$id : int

Order ID.

Tags
throws
ArgumentNullException
Return values
Result

getField()

public getField(mixed $name) : null|string
Parameters
$name : mixed
Return values
null|string

getFieldValues()

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

getList()

public static getList([mixed $sort = array() ][, mixed $filter = array() ][, null|array<string|int, mixed> $group = null ][, mixed $nav = array() ][, mixed $select = array() ][, mixed $callback = false ]) : CDBResult
Parameters
$sort : mixed = array()
$filter : mixed = array()
$group : null|array<string|int, mixed> = null
$nav : mixed = array()
$select : mixed = array()
$callback : mixed = false
Return values
CDBResult

getOrderFields()

public static getOrderFields(Order $order) : Result
Parameters
$order : Order
Return values
Result

getRequestFields()

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

parseField()

public parseField(mixed $key) : null|string
Parameters
$key : mixed
Return values
null|string

pay()

public static pay(mixed $orderId, array<string|int, mixed> $values[, bool $withdraw = false ][, bool $pay = false ]) : Result
Parameters
$orderId : mixed
$values : array<string|int, mixed>
$withdraw : bool = false
$pay : bool = false
Tags
throws
ObjectNotFoundException
throws
ArgumentNullException
Return values
Result

payFromBudget()

Paid from internal account

public static payFromBudget(Order $order, bool $pay[, null $paidFormUserBudget = null ]) : Result
Parameters
$order : Order

Entity of the order.

$pay : bool

Flag making donations to internal account.

$paidFormUserBudget : null = null
Tags
throws
ObjectNotFoundException
throws
ArgumentOutOfRangeException
throws
InvalidOperationException
Return values
Result

reserve()

public static reserve(mixed $orderId, mixed $value) : Result
Parameters
$orderId : mixed
$value : mixed
Tags
throws
ObjectNotFoundException
throws
ArgumentNullException
Return values
Result

saveRawFields()

public saveRawFields(mixed $entity, mixed $entityName) : Result
Parameters
$entity : mixed
$entityName : mixed
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
ObjectNotFoundException
Return values
Result

setCallback()

public setCallback(array<string|int, mixed> $callback) : mixed
Parameters
$callback : array<string|int, mixed>

setField()

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

setFields()

public setFields(array<string|int, mixed> $values) : mixed
Parameters
$values : array<string|int, mixed>

setFilter()

public setFilter([array<string|int, mixed> $filter = array() ]) : mixed
Parameters
$filter : array<string|int, mixed> = array()

setGroup()

public setGroup([array<string|int, mixed> $group = null ]) : mixed
Parameters
$group : array<string|int, mixed> = null

setNav()

public setNav([array<string|int, mixed> $nav = array() ]) : mixed
Parameters
$nav : array<string|int, mixed> = array()

setSelect()

public setSelect([array<string|int, mixed> $select = array() ]) : mixed
Parameters
$select : array<string|int, mixed> = array()

setSort()

public setSort([array<string|int, mixed> $sort = array() ]) : mixed
Parameters
$sort : array<string|int, mixed> = array()

shipment()

public static shipment(mixed $id, bool $value[, array<string|int, mixed> $storeData = array() ]) : Result
Parameters
$id : mixed
$value : bool
$storeData : array<string|int, mixed> = array()
Tags
throws
ObjectNotFoundException
throws
ArgumentNullException
throws
NotSupportedException
Return values
Result

update()

public static update(mixed $id, array<string|int, mixed> $fields[, bool $dateUpdate = false ]) : Result
Parameters
$id : mixed
$fields : array<string|int, mixed>
$dateUpdate : bool = false
Return values
Result 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results