Bitrix API

Order extends Controller

Table of Contents

Constants

ERROR_REQUIRED_PARAMETER  = 'MAIN_CONTROLLER_22001'
ERROR_UNKNOWN_ACTION  = 'MAIN_CONTROLLER_22002'
EVENT_ON_AFTER_ACTION  = 'onAfterAction'
EVENT_ON_BEFORE_ACTION  = 'onBeforeAction'
EXCEPTION_UNKNOWN_ACTION  = 22002
SCOPE_AJAX  = 'ajax'
SCOPE_CLI  = 'cli'
SCOPE_REST  = 'rest'

Methods

__construct()  : mixed
Constructor Controller.
addAction()  : mixed
className()  : string
Returns the fully qualified name of this class.
configureActions()  : array<string|int, mixed>
convertKeysToCamelCase()  : array<string|int, mixed>|mixed|string
Converts keys of array to camel case notation.
deleteAction()  : mixed
finalizeResponse()  : void
Finalizes response.
forward()  : HttpResponse|mixed
generateActionMethodName()  : string
getAction()  : mixed
getActionUri()  : Uri
Returns uri for ajax end point for the action name. It's a helper, which uses relative action name without controller name.
getApplyDiscountAction()  : mixed
getAutoWiredParameters()  : array<string|int, Parameter>
getBasketAction()  : mixed
getBuilder()  : mixed
getConfigurationOfActions()  : array<string|int, mixed>|null
getCurrencyAction()  : mixed
getCurrentUser()  : CurrentUser
getDateInsertAction()  : mixed
getDefaultAutoWiredParameters()  : array<string|int, Parameter>
getDeliveryIdListAction()  : mixed
getErrorByCode()  : Error
Getting once error with the necessary code.
getErrors()  : array<string|int, Error>
Getting array of errors.
getFieldsAction()  : mixed
getFullEventName()  : string
getModuleId()  : string
Returns module id.
getPaymentsAction()  : mixed
getPaySystemIdListAction()  : mixed
getPersonTypeIdAction()  : mixed
getPriceAction()  : mixed
getPrimaryAutoWiredParameter()  : Parameter|null
getPrintedChecksAction()  : mixed
getPropertyValuesAction()  : mixed
getRequest()  : HttpRequest
getScope()  : string
getShipmentsAction()  : mixed
getSiteIdAction()  : mixed
getSourceParametersList()  : array<string|int, mixed>
getSumPaidAction()  : mixed
getTaxPriceAction()  : mixed
getTaxValueAction()  : mixed
getUnsignedParameters()  : mixed
getUserIdAction()  : mixed
getVatRateAction()  : mixed
getVatSumAction()  : mixed
importAction()  : mixed
importDeleteAction()  : mixed
isCanceledAction()  : mixed
isExternalAction()  : mixed
isLocatedUnderPsr4()  : bool
isMarkedAction()  : mixed
isPaidAction()  : mixed
isShippedAction()  : mixed
isUsedVatAction()  : mixed
listAction()  : Page
listNameActions()  : array<string|int, mixed>
Returns list of all
modifyAction()  : mixed
prepareFields()  : mixed
prepareFieldsImport()  : mixed
redirectTo()  : Redirect
Redirect to URL.
resolveExternalIdToInternalId()  : mixed
run()  : HttpResponse|mixed
setCurrentUser()  : void
setScope()  : Controller
setSourceParametersList()  : Controller
tryAddAction()  : mixed
tryModifyAction()  : mixed
tryUpdateAction()  : mixed
updateAction()  : mixed

Constants

ERROR_REQUIRED_PARAMETER

public mixed ERROR_REQUIRED_PARAMETER = 'MAIN_CONTROLLER_22001'

ERROR_UNKNOWN_ACTION

public mixed ERROR_UNKNOWN_ACTION = 'MAIN_CONTROLLER_22002'

EVENT_ON_AFTER_ACTION

public mixed EVENT_ON_AFTER_ACTION = 'onAfterAction'

EVENT_ON_BEFORE_ACTION

public mixed EVENT_ON_BEFORE_ACTION = 'onBeforeAction'

EXCEPTION_UNKNOWN_ACTION

public mixed EXCEPTION_UNKNOWN_ACTION = 22002

Methods

__construct()

Constructor Controller.

public __construct([Request|null $request = null ]) : mixed
Parameters
$request : Request|null = null

addAction()

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

className()

Returns the fully qualified name of this class.

public final static className() : string
Return values
string

configureActions()

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

convertKeysToCamelCase()

Converts keys of array to camel case notation.

public convertKeysToCamelCase(mixed $data) : array<string|int, mixed>|mixed|string
Parameters
$data : mixed

Data.

Tags
see
Converter::OUTPUT_JSON_FORMAT
Return values
array<string|int, mixed>|mixed|string

deleteAction()

public deleteAction(Order $order) : mixed
Parameters
$order : Order

finalizeResponse()

Finalizes response.

public finalizeResponse(Response $response) : void

The method will be invoked when HttpApplication will be ready to send response to client. It's a final place where Controller can interact with response.

Parameters
$response : Response

forward()

public forward(Controller|string $controller, string $actionName[, array<string|int, mixed>|null $parameters = null ]) : HttpResponse|mixed
Parameters
$controller : Controller|string
$actionName : string
$parameters : array<string|int, mixed>|null = null
Tags
throws
SystemException
Return values
HttpResponse|mixed

generateActionMethodName()

public final generateActionMethodName(mixed $action) : string
Parameters
$action : mixed
Return values
string

getAction()

public getAction(Order $order) : mixed
Parameters
$order : Order

getActionUri()

Returns uri for ajax end point for the action name. It's a helper, which uses relative action name without controller name.

public final getActionUri(string $actionName[, array<string|int, mixed> $params = [] ][, bool $absolute = false ]) : Uri
Parameters
$actionName : string

Action name. It's a relative action name without controller name.

$params : array<string|int, mixed> = []

Parameters for creating uri.

$absolute : bool = false
Return values
Uri

getApplyDiscountAction()

public getApplyDiscountAction(Order $order) : mixed
Parameters
$order : Order

getBasketAction()

public getBasketAction(Order $order) : mixed
Parameters
$order : Order

getConfigurationOfActions()

public final getConfigurationOfActions() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getCurrencyAction()

public getCurrencyAction(Order $order) : mixed
Parameters
$order : Order

getDateInsertAction()

public getDateInsertAction(Order $order) : mixed
Parameters
$order : Order

getDefaultAutoWiredParameters()

public final getDefaultAutoWiredParameters() : array<string|int, Parameter>
Return values
array<string|int, Parameter>

getDeliveryIdListAction()

public getDeliveryIdListAction(Order $order) : mixed
Parameters
$order : Order

getErrorByCode()

Getting once error with the necessary code.

public final getErrorByCode(string $code) : Error
Parameters
$code : string

Code of error.

Return values
Error

getErrors()

Getting array of errors.

public final getErrors() : array<string|int, Error>
Return values
array<string|int, Error>

getFieldsAction()

public getFieldsAction() : mixed

getFullEventName()

public final static getFullEventName(mixed $eventName) : string
Parameters
$eventName : mixed
Return values
string

getModuleId()

Returns module id.

public final getModuleId() : string

Tries to guess module id by file path and function @see getModuleId().

Return values
string

getPaymentsAction()

public getPaymentsAction(Order $order) : mixed
Parameters
$order : Order

getPaySystemIdListAction()

public getPaySystemIdListAction(Order $order) : mixed
Parameters
$order : Order

getPersonTypeIdAction()

public getPersonTypeIdAction(Order $order) : mixed
Parameters
$order : Order

getPriceAction()

public getPriceAction(Order $order) : mixed
Parameters
$order : Order

getPrintedChecksAction()

public getPrintedChecksAction(Order $order) : mixed
Parameters
$order : Order

getPropertyValuesAction()

public getPropertyValuesAction(Order $order) : mixed
Parameters
$order : Order

getRequest()

public final getRequest() : HttpRequest
Return values
HttpRequest

getScope()

public final getScope() : string
Return values
string

getShipmentsAction()

public getShipmentsAction(Order $order) : mixed
Parameters
$order : Order

getSiteIdAction()

public getSiteIdAction(Order $order) : mixed
Parameters
$order : Order

getSourceParametersList()

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

getSumPaidAction()

public getSumPaidAction(Order $order) : mixed
Parameters
$order : Order

getTaxPriceAction()

public getTaxPriceAction(Order $order) : mixed
Parameters
$order : Order

getTaxValueAction()

public getTaxValueAction(Order $order) : mixed
Parameters
$order : Order

getUnsignedParameters()

public final getUnsignedParameters() : mixed

getUserIdAction()

public getUserIdAction(Order $order) : mixed
Parameters
$order : Order

getVatRateAction()

public getVatRateAction(Order $order) : mixed
Parameters
$order : Order

getVatSumAction()

public getVatSumAction(Order $order) : mixed
Parameters
$order : Order

importAction()

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

importDeleteAction()

public importDeleteAction(Order $order) : mixed
Parameters
$order : Order

isCanceledAction()

public isCanceledAction(Order $order) : mixed
Parameters
$order : Order

isExternalAction()

public isExternalAction(Order $order) : mixed
Parameters
$order : Order

isLocatedUnderPsr4()

public final isLocatedUnderPsr4() : bool
Return values
bool

isMarkedAction()

public isMarkedAction(Order $order) : mixed
Parameters
$order : Order

isPaidAction()

public isPaidAction(Order $order) : mixed
Parameters
$order : Order

isShippedAction()

public isShippedAction(Order $order) : mixed
Parameters
$order : Order

isUsedVatAction()

public isUsedVatAction(Order $order) : mixed
Parameters
$order : Order

listAction()

public listAction(PageNavigation $pageNavigation[, array<string|int, mixed> $select = [] ][, array<string|int, mixed> $filter = [] ][, array<string|int, mixed> $order = [] ][, bool $__calculateTotalCount = true ]) : Page
Parameters
$pageNavigation : PageNavigation
$select : array<string|int, mixed> = []
$filter : array<string|int, mixed> = []
$order : array<string|int, mixed> = []
$__calculateTotalCount : bool = true
Return values
Page

listNameActions()

Returns list of all

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

modifyAction()

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

prepareFields()

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

prepareFieldsImport()

public prepareFieldsImport(mixed $fields) : mixed
Parameters
$fields : mixed

resolveExternalIdToInternalId()

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

run()

public final run(mixed $actionName, array<string|int, mixed> $sourceParametersList) : HttpResponse|mixed
Parameters
$actionName : mixed
$sourceParametersList : array<string|int, mixed>
Tags
throws
SystemException
Return values
HttpResponse|mixed

setSourceParametersList()

public final setSourceParametersList(array<string|int, mixed> $sourceParametersList) : Controller
Parameters
$sourceParametersList : array<string|int, mixed>
Return values
Controller

tryAddAction()

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

tryModifyAction()

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

tryUpdateAction()

public tryUpdateAction(Order $order, array<string|int, mixed> $fields) : mixed
Parameters
$order : Order
$fields : array<string|int, mixed>

updateAction()

public updateAction(Order $order, array<string|int, mixed> $fields) : mixed
Parameters
$order : Order
$fields : array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results