Bitrix API

EventCompatibility extends EntityCompatibility

Table of Contents

Constants

ENTITY_ORDER  = 'ORDER'
ENTITY_ORDER_TABLE  = 'b_sale_order'
ENTITY_PAYMENT  = 'PAYMENT'
ENTITY_PAYMENT_TABLE  = 'b_sale_order_payment'
EVENT_COMPATIBILITY_MOBILE_PUSH_ORDER_STATUS_CHANGE  = "ORDER_STATUS_CHANGED"
EVENT_COMPATIBILITY_ON_BASKET_DELETED  = "OnBasketDelete"
EVENT_COMPATIBILITY_ON_BASKET_ITEM_ADD  = "OnBasketAdd"
EVENT_COMPATIBILITY_ON_BASKET_ITEM_UPDATE  = "OnBasketUpdate"
EVENT_COMPATIBILITY_ON_BEFORE_BASKET_DELETE  = "OnBeforeBasketDelete"
EVENT_COMPATIBILITY_ON_BEFORE_BASKET_ITEM_ADD  = "OnBeforeBasketAdd"
EVENT_COMPATIBILITY_ON_BEFORE_BASKET_ITEM_UPDATE  = "OnBeforeBasketUpdate"
EVENT_COMPATIBILITY_ON_BEFORE_ORDER_ADD  = "OnBeforeOrderAdd"
EVENT_COMPATIBILITY_ON_BEFORE_ORDER_CANCELED  = "OnSaleBeforeCancelOrder"
EVENT_COMPATIBILITY_ON_BEFORE_ORDER_DELETE  = "OnBeforeOrderDelete"
EVENT_COMPATIBILITY_ON_BEFORE_ORDER_STATUS_CHANGE  = "OnSaleBeforeStatusOrder"
EVENT_COMPATIBILITY_ON_BEFORE_ORDER_UPDATE  = "OnBeforeOrderUpdate"
EVENT_COMPATIBILITY_ON_ORDER_ADD  = "OnOrderAdd"
EVENT_COMPATIBILITY_ON_ORDER_CANCEL_SEND_EMAIL  = "OnOrderCancelSendEmail"
EVENT_COMPATIBILITY_ON_ORDER_CANCELED  = "OnSaleCancelOrder"
EVENT_COMPATIBILITY_ON_ORDER_DELETED  = "OnOrderDelete"
EVENT_COMPATIBILITY_ON_ORDER_DELIVER_SEND_EMAIL  = "OnOrderDeliverSendEmail"
EVENT_COMPATIBILITY_ON_ORDER_NEW_SEND_EMAIL  = "OnOrderNewSendEmail"
EVENT_COMPATIBILITY_ON_ORDER_PAID  = "OnSalePayOrder"
EVENT_COMPATIBILITY_ON_ORDER_PAID_SEND_EMAIL  = "OnOrderPaySendEmail"
EVENT_COMPATIBILITY_ON_ORDER_SAVE  = "OnOrderSave"
EVENT_COMPATIBILITY_ON_ORDER_STATUS_CHANGE  = "OnSaleStatusOrder"
EVENT_COMPATIBILITY_ON_ORDER_UPDATE  = "OnOrderUpdate"
EVENT_COMPATIBILITY_ON_SHIPMENT_DELIVER  = "OnSaleDeliveryOrder"
EVENT_COMPATIBILITY_ON_TRACKING_NUMBER_CHANGE  = "OnTrackingNumberChange"
EVENT_COMPATIBILITY_ORDER_CANCEL_SEND_EMAIL_EVENT_NAME  = "SALE_ORDER_CANCEL"
EVENT_COMPATIBILITY_ORDER_DELIVER_SEND_EMAIL_EVENT_NAME  = "SALE_ORDER_DELIVERY"
EVENT_COMPATIBILITY_ORDER_NEW_SEND_EMAIL_EVENT_NAME  = "SALE_NEW_ORDER"
EVENT_COMPATIBILITY_ORDER_STATUS_EMAIL  = "OnSaleStatusEMail"
EVENT_COMPATIBILITY_ORDER_STATUS_SEND_EMAIL  = "OnOrderStatusSendEmail"

Methods

add()  : mixed
backRawField()  : array<string|int, mixed>
convertDateFieldsToOldFormat()  : array<string|int, mixed>
Convert an array of dates from the object to a string
execute()  : CDBResult|int
getById()  : CDBResult
getEventListUsed()  : bool
getField()  : null|string
getFieldValues()  : array<string|int, mixed>
getList()  : CDBResult
onBasketDelete()  : EventResult
onBasketItemBeforeChange()  : EventResult
onBasketItemChange()  : EventResult
onBeforeBasketDelete()  : EventResult
onBeforeOrderDelete()  : EventResult
onCallOrderCancelSendEmail()  : bool
onCallOrderNewSendEmail()  : bool
onOrderAdd()  : EventResult
onOrderBeforeSaved()  : EventResult
onOrderDelete()  : EventResult
onOrderNewSendEmail()  : EventResult
onOrderSave()  : EventResult
onOrderSaved()  : EventResult
onSaleBeforeCancelOrder()  : EventResult
onSaleBeforeStatusOrderChange()  : EventResult
onSaleCancelOrder()  : EventResult
onSaleDeliveryOrder()  : EventResult
onSaleOrderCancelSendEmail()  : EventResult
onSaleOrderPaidSendMail()  : EventResult
onSaleOrderStatusChangeSendEmail()  : EventResult
onSalePayOrder()  : EventResult
onSaleStatusOrderChange()  : EventResult
onShipmentAllowDelivery()  : EventResult
onShipmentTrackingNumberChange()  : EventResult
parseField()  : null|string
registerEvents()  : mixed
saveRawFields()  : Result
setCallback()  : mixed
setDisableMailSend()  : mixed
setField()  : mixed
setFields()  : mixed
setFilter()  : mixed
setGroup()  : mixed
setNav()  : mixed
setSelect()  : mixed
setSort()  : mixed
unRegisterEvents()  : mixed

Constants

EVENT_COMPATIBILITY_MOBILE_PUSH_ORDER_STATUS_CHANGE

public mixed EVENT_COMPATIBILITY_MOBILE_PUSH_ORDER_STATUS_CHANGE = "ORDER_STATUS_CHANGED"

EVENT_COMPATIBILITY_ON_BASKET_DELETED

public mixed EVENT_COMPATIBILITY_ON_BASKET_DELETED = "OnBasketDelete"

EVENT_COMPATIBILITY_ON_BASKET_ITEM_ADD

public mixed EVENT_COMPATIBILITY_ON_BASKET_ITEM_ADD = "OnBasketAdd"

EVENT_COMPATIBILITY_ON_BASKET_ITEM_UPDATE

public mixed EVENT_COMPATIBILITY_ON_BASKET_ITEM_UPDATE = "OnBasketUpdate"

EVENT_COMPATIBILITY_ON_BEFORE_BASKET_DELETE

public mixed EVENT_COMPATIBILITY_ON_BEFORE_BASKET_DELETE = "OnBeforeBasketDelete"

EVENT_COMPATIBILITY_ON_BEFORE_BASKET_ITEM_ADD

public mixed EVENT_COMPATIBILITY_ON_BEFORE_BASKET_ITEM_ADD = "OnBeforeBasketAdd"

EVENT_COMPATIBILITY_ON_BEFORE_BASKET_ITEM_UPDATE

public mixed EVENT_COMPATIBILITY_ON_BEFORE_BASKET_ITEM_UPDATE = "OnBeforeBasketUpdate"

EVENT_COMPATIBILITY_ON_BEFORE_ORDER_ADD

public mixed EVENT_COMPATIBILITY_ON_BEFORE_ORDER_ADD = "OnBeforeOrderAdd"

EVENT_COMPATIBILITY_ON_BEFORE_ORDER_CANCELED

public mixed EVENT_COMPATIBILITY_ON_BEFORE_ORDER_CANCELED = "OnSaleBeforeCancelOrder"

EVENT_COMPATIBILITY_ON_BEFORE_ORDER_DELETE

public mixed EVENT_COMPATIBILITY_ON_BEFORE_ORDER_DELETE = "OnBeforeOrderDelete"

EVENT_COMPATIBILITY_ON_BEFORE_ORDER_STATUS_CHANGE

public mixed EVENT_COMPATIBILITY_ON_BEFORE_ORDER_STATUS_CHANGE = "OnSaleBeforeStatusOrder"

EVENT_COMPATIBILITY_ON_BEFORE_ORDER_UPDATE

public mixed EVENT_COMPATIBILITY_ON_BEFORE_ORDER_UPDATE = "OnBeforeOrderUpdate"

EVENT_COMPATIBILITY_ON_ORDER_ADD

public mixed EVENT_COMPATIBILITY_ON_ORDER_ADD = "OnOrderAdd"

EVENT_COMPATIBILITY_ON_ORDER_CANCEL_SEND_EMAIL

public mixed EVENT_COMPATIBILITY_ON_ORDER_CANCEL_SEND_EMAIL = "OnOrderCancelSendEmail"

EVENT_COMPATIBILITY_ON_ORDER_CANCELED

public mixed EVENT_COMPATIBILITY_ON_ORDER_CANCELED = "OnSaleCancelOrder"

EVENT_COMPATIBILITY_ON_ORDER_DELETED

public mixed EVENT_COMPATIBILITY_ON_ORDER_DELETED = "OnOrderDelete"

EVENT_COMPATIBILITY_ON_ORDER_DELIVER_SEND_EMAIL

public mixed EVENT_COMPATIBILITY_ON_ORDER_DELIVER_SEND_EMAIL = "OnOrderDeliverSendEmail"

EVENT_COMPATIBILITY_ON_ORDER_NEW_SEND_EMAIL

public mixed EVENT_COMPATIBILITY_ON_ORDER_NEW_SEND_EMAIL = "OnOrderNewSendEmail"

EVENT_COMPATIBILITY_ON_ORDER_PAID

public mixed EVENT_COMPATIBILITY_ON_ORDER_PAID = "OnSalePayOrder"

EVENT_COMPATIBILITY_ON_ORDER_PAID_SEND_EMAIL

public mixed EVENT_COMPATIBILITY_ON_ORDER_PAID_SEND_EMAIL = "OnOrderPaySendEmail"

EVENT_COMPATIBILITY_ON_ORDER_SAVE

public mixed EVENT_COMPATIBILITY_ON_ORDER_SAVE = "OnOrderSave"

EVENT_COMPATIBILITY_ON_ORDER_STATUS_CHANGE

public mixed EVENT_COMPATIBILITY_ON_ORDER_STATUS_CHANGE = "OnSaleStatusOrder"

EVENT_COMPATIBILITY_ON_ORDER_UPDATE

public mixed EVENT_COMPATIBILITY_ON_ORDER_UPDATE = "OnOrderUpdate"

EVENT_COMPATIBILITY_ON_SHIPMENT_DELIVER

public mixed EVENT_COMPATIBILITY_ON_SHIPMENT_DELIVER = "OnSaleDeliveryOrder"

EVENT_COMPATIBILITY_ON_TRACKING_NUMBER_CHANGE

public mixed EVENT_COMPATIBILITY_ON_TRACKING_NUMBER_CHANGE = "OnTrackingNumberChange"

EVENT_COMPATIBILITY_ORDER_CANCEL_SEND_EMAIL_EVENT_NAME

public mixed EVENT_COMPATIBILITY_ORDER_CANCEL_SEND_EMAIL_EVENT_NAME = "SALE_ORDER_CANCEL"

EVENT_COMPATIBILITY_ORDER_DELIVER_SEND_EMAIL_EVENT_NAME

public mixed EVENT_COMPATIBILITY_ORDER_DELIVER_SEND_EMAIL_EVENT_NAME = "SALE_ORDER_DELIVERY"

EVENT_COMPATIBILITY_ORDER_NEW_SEND_EMAIL_EVENT_NAME

public mixed EVENT_COMPATIBILITY_ORDER_NEW_SEND_EMAIL_EVENT_NAME = "SALE_NEW_ORDER"

EVENT_COMPATIBILITY_ORDER_STATUS_EMAIL

public mixed EVENT_COMPATIBILITY_ORDER_STATUS_EMAIL = "OnSaleStatusEMail"

EVENT_COMPATIBILITY_ORDER_STATUS_SEND_EMAIL

public mixed EVENT_COMPATIBILITY_ORDER_STATUS_SEND_EMAIL = "OnOrderStatusSendEmail"

Methods

add()

public static add(array<string|int, mixed> $fields) : mixed
Parameters
$fields : array<string|int, mixed>
Tags
throws
SystemException

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>

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>

getEventListUsed()

public static getEventListUsed(string $event) : bool
Parameters
$event : string
Return values
bool

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

onBasketDelete()

public static onBasketDelete(Event $event) : EventResult
Parameters
$event : Event
Return values
EventResult

onBasketItemBeforeChange()

public static onBasketItemBeforeChange(Event $event) : EventResult
Parameters
$event : Event
Tags
throws
ObjectNotFoundException
Return values
EventResult

onBasketItemChange()

public static onBasketItemChange(Event $event) : EventResult
Parameters
$event : Event
Return values
EventResult

onBeforeBasketDelete()

public static onBeforeBasketDelete(Event $event) : EventResult
Parameters
$event : Event
Return values
EventResult

onBeforeOrderDelete()

public static onBeforeOrderDelete(Event $event) : EventResult
Parameters
$event : Event
Return values
EventResult

onCallOrderCancelSendEmail()

public static onCallOrderCancelSendEmail(mixed $id, mixed $eventName, mixed $fields) : bool
Parameters
$id : mixed
$eventName : mixed
$fields : mixed
Return values
bool

onCallOrderNewSendEmail()

public static onCallOrderNewSendEmail(mixed $id, mixed $eventName, mixed $fields) : bool
Parameters
$id : mixed
$eventName : mixed
$fields : mixed
Return values
bool

onOrderAdd()

public static onOrderAdd(Event $event) : EventResult
Parameters
$event : Event
Return values
EventResult

onOrderBeforeSaved()

public static onOrderBeforeSaved(Event $event) : EventResult
Parameters
$event : Event
Return values
EventResult

onOrderDelete()

public static onOrderDelete(Event $event) : EventResult
Parameters
$event : Event
Return values
EventResult

onOrderNewSendEmail()

public static onOrderNewSendEmail(Event $event) : EventResult
Parameters
$event : Event
Return values
EventResult

onOrderSave()

public static onOrderSave(Event $event) : EventResult
Parameters
$event : Event
Return values
EventResult

onOrderSaved()

public static onOrderSaved(Event $event) : EventResult
Parameters
$event : Event
Return values
EventResult

onSaleBeforeCancelOrder()

public static onSaleBeforeCancelOrder(Event $event) : EventResult
Parameters
$event : Event
Return values
EventResult

onSaleBeforeStatusOrderChange()

public static onSaleBeforeStatusOrderChange(Event $event) : EventResult
Parameters
$event : Event
Tags
throws
ObjectNotFoundException
Return values
EventResult

onSaleCancelOrder()

public static onSaleCancelOrder(Event $event) : EventResult
Parameters
$event : Event
Return values
EventResult

onSaleDeliveryOrder()

public static onSaleDeliveryOrder(Event $event) : EventResult
Parameters
$event : Event
Tags
throws
ObjectNotFoundException
Return values
EventResult

onSaleOrderCancelSendEmail()

public static onSaleOrderCancelSendEmail(Event $event) : EventResult
Parameters
$event : Event
Return values
EventResult

onSaleOrderPaidSendMail()

public static onSaleOrderPaidSendMail(Event $event) : EventResult
Parameters
$event : Event
Return values
EventResult

onSaleOrderStatusChangeSendEmail()

public static onSaleOrderStatusChangeSendEmail(Event $event) : EventResult
Parameters
$event : Event
Tags
throws
ObjectNotFoundException
Return values
EventResult

onSalePayOrder()

public static onSalePayOrder(Event $event) : EventResult
Parameters
$event : Event
Return values
EventResult

onSaleStatusOrderChange()

public static onSaleStatusOrderChange(Event $event) : EventResult
Parameters
$event : Event
Tags
throws
ObjectNotFoundException
Return values
EventResult

onShipmentAllowDelivery()

public static onShipmentAllowDelivery(Event $event) : EventResult
Parameters
$event : Event
Tags
throws
ObjectNotFoundException
Return values
EventResult

onShipmentTrackingNumberChange()

public static onShipmentTrackingNumberChange(Event $event) : EventResult
Parameters
$event : Event
Tags
throws
ObjectNotFoundException
Return values
EventResult

parseField()

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

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>

setDisableMailSend()

public static setDisableMailSend(mixed $value) : mixed
Parameters
$value : 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() 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results