Bitrix API

Product extends Controller implements EventBindInterface uses SkuDeferredCalculations

Table of Contents

Interfaces

EventBindInterface
Interface EventBindInterface for subscribing to PHP Bitrix events and implementing handlers transferred to REST events

Constants

CATALOG_GROUP  = \Bitrix\Catalog\Access\ActionDictionary::ACTION_PRICE_GROUP_EDIT
CATALOG_READ  = \Bitrix\Catalog\Access\ActionDictionary::ACTION_CATALOG_READ
CATALOG_STORE  = \Bitrix\Catalog\Access\ActionDictionary::ACTION_STORE_VIEW
CATALOG_VAT  = \Bitrix\Catalog\Access\ActionDictionary::ACTION_VAT_EDIT
ERROR_ACCESS_DENIED  = 'Access denied'
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
IBLOCK_EDIT  = 'iblock_edit'
IBLOCK_ELEMENT_DELETE  = 'element_delete'
IBLOCK_ELEMENT_EDIT  = 'element_edit'
IBLOCK_ELEMENT_EDIT_PRICE  = 'element_edit_price'
IBLOCK_ELEMENT_READ  = 'element_read'
IBLOCK_ELEMENT_SECTION_BIND  = 'section_element_bind'
IBLOCK_READ  = 'iblock_admin_display'
IBLOCK_SECTION_DELETE  = 'section_delete'
IBLOCK_SECTION_EDIT  = 'section_edit'
IBLOCK_SECTION_READ  = 'section_read'
IBLOCK_SECTION_SECTION_BIND  = 'section_section_bind'
SCOPE_AJAX  = 'ajax'
SCOPE_CLI  = 'cli'
SCOPE_REST  = 'rest'

Methods

__construct()  : mixed
Constructor Controller.
add()  : AddResult
addAction()  : array<string|int, mixed>|null
addPropertyAction()  : 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()  : bool|null
downloadAction()  : BFile|null
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.
getAutoWiredParameters()  : array<string|int, Parameter>
getCallbackRestEvent()  : array<string|int, mixed>
getConfigurationOfActions()  : array<string|int, mixed>|null
getCurrentUser()  : CurrentUser
getDefaultAutoWiredParameters()  : array<string|int, Parameter>
getEntity()  : Entity
getErrorByCode()  : Error
Getting once error with the necessary code.
getErrors()  : array<string|int, Error>
Getting array of errors.
getFieldsByFilterAction()  : array<string|int, mixed>|null
getFullEventName()  : string
getHandlers()  : array<string|int, mixed>
getModuleId()  : string
Returns module id.
getPrimaryAutoWiredParameter()  : Parameter|null
getRequest()  : HttpRequest
getScope()  : string
getSourceParametersList()  : array<string|int, mixed>
getUnsignedParameters()  : mixed
getViewManager()  : ViewManager
isLocatedUnderPsr4()  : bool
listAction()  : Page|null
listNameActions()  : array<string|int, mixed>
Returns list of all
processItemEvent()  : array<string|int, mixed>
redirectTo()  : Redirect
Redirect to URL.
run()  : HttpResponse|mixed
setCurrentUser()  : void
setScope()  : Controller
setSourceParametersList()  : Controller
updateAction()  : array<string|int, mixed>|null

Constants

CATALOG_GROUP

public mixed CATALOG_GROUP = \Bitrix\Catalog\Access\ActionDictionary::ACTION_PRICE_GROUP_EDIT

CATALOG_READ

public mixed CATALOG_READ = \Bitrix\Catalog\Access\ActionDictionary::ACTION_CATALOG_READ

CATALOG_STORE

public mixed CATALOG_STORE = \Bitrix\Catalog\Access\ActionDictionary::ACTION_STORE_VIEW

CATALOG_VAT

public mixed CATALOG_VAT = \Bitrix\Catalog\Access\ActionDictionary::ACTION_VAT_EDIT

ERROR_ACCESS_DENIED

public mixed ERROR_ACCESS_DENIED = 'Access denied'

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

IBLOCK_EDIT

public mixed IBLOCK_EDIT = 'iblock_edit'

IBLOCK_ELEMENT_DELETE

public mixed IBLOCK_ELEMENT_DELETE = 'element_delete'

IBLOCK_ELEMENT_EDIT

public mixed IBLOCK_ELEMENT_EDIT = 'element_edit'

IBLOCK_ELEMENT_EDIT_PRICE

public mixed IBLOCK_ELEMENT_EDIT_PRICE = 'element_edit_price'

IBLOCK_ELEMENT_READ

public mixed IBLOCK_ELEMENT_READ = 'element_read'

IBLOCK_ELEMENT_SECTION_BIND

public mixed IBLOCK_ELEMENT_SECTION_BIND = 'section_element_bind'

IBLOCK_READ

public mixed IBLOCK_READ = 'iblock_admin_display'

IBLOCK_SECTION_DELETE

public mixed IBLOCK_SECTION_DELETE = 'section_delete'

IBLOCK_SECTION_EDIT

public mixed IBLOCK_SECTION_EDIT = 'section_edit'

IBLOCK_SECTION_READ

public mixed IBLOCK_SECTION_READ = 'section_read'

IBLOCK_SECTION_SECTION_BIND

public mixed IBLOCK_SECTION_SECTION_BIND = 'section_section_bind'

Methods

__construct()

Constructor Controller.

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

add()

public add(array<string|int, mixed> $fields) : AddResult
Parameters
$fields : array<string|int, mixed>
Tags
throws
NotImplementedException
Return values
AddResult

addAction()

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

addPropertyAction()

public addPropertyAction(mixed $fields) : mixed
Parameters
$fields : 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>
Tags
inheritDoc
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(int $id) : bool|null
Parameters
$id : int
Return values
bool|null

downloadAction()

public downloadAction(array<string|int, mixed> $fields) : BFile|null
Parameters
$fields : array<string|int, mixed>
Return values
BFile|null

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(mixed $id) : mixed
Parameters
$id : mixed

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

getCallbackRestEvent()

public static getCallbackRestEvent() : array<string|int, mixed>
Tags
inheritDoc
Return values
array<string|int, mixed>

getConfigurationOfActions()

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

getDefaultAutoWiredParameters()

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

getEntity()

public getEntity() : Entity
Tags
throws
ArgumentException
throws
NotImplementedException
throws
SystemException
Return values
Entity

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>

getFieldsByFilterAction()

public getFieldsByFilterAction(mixed $filter) : array<string|int, mixed>|null
Parameters
$filter : mixed
Return values
array<string|int, mixed>|null

getFullEventName()

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

getHandlers()

public static getHandlers() : array<string|int, mixed>
Tags
@implements

EventBindInterface

Return values
array<string|int, mixed>

getModuleId()

Returns module id.

public final getModuleId() : string

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

Return values
string

getRequest()

public final getRequest() : HttpRequest
Return values
HttpRequest

getScope()

public final getScope() : string
Return values
string

getSourceParametersList()

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

getUnsignedParameters()

public final getUnsignedParameters() : mixed

isLocatedUnderPsr4()

public final isLocatedUnderPsr4() : bool
Return values
bool

listAction()

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

listNameActions()

Returns list of all

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

processItemEvent()

public static processItemEvent(array<string|int, mixed> $params, array<string|int, mixed> $handler) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
$handler : array<string|int, mixed>
Return values
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

updateAction()

public updateAction(int $id, array<string|int, mixed> $fields) : array<string|int, mixed>|null
Parameters
$id : int
$fields : array<string|int, mixed>
Return values
array<string|int, mixed>|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results