Bitrix API

Document extends Controller

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.
changeBlankAction() : array{uid: string}
className() : string: Returns the fully qualified name of this class.
configureAction() : array<string|int, mixed>
configureActions() : array<string|int, mixed>
convertKeysToCamelCase() : array<string|int, mixed>|mixed|string: Converts keys of array to camel case notation.
finalizeResponse() : void: Finalizes response.
forward() : HttpResponse|mixed
generateActionMethodName() : string
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>
getConfigurationOfActions() : array<string|int, mixed>|null
getCurrentUser() : CurrentUser
getDefaultAutoWiredParameters() : array<string|int, Parameter>
getErrorByCode() : Error: Getting once error with the necessary code.
getErrors() : array<string|int, Error>: Getting array of errors.
getFillAndStartProgressAction() : array<string|int, mixed>
getFullEventName() : string
getModuleId() : string: Returns module id.
getPrimaryAutoWiredParameter() : Parameter|null
getRequest() : HttpRequest
getScope() : string
getSourceParametersList() : array<string|int, mixed>
getUnsignedParameters() : mixed
isLocatedUnderPsr4() : bool
isNotAcceptedAgreement() : bool
listNameActions() : array<string|int, mixed>: Returns list of all
loadAction() : array<string|int, mixed>
loadByIdAction() : array<string|int, mixed>
loadLanguageAction() : array<string|int, mixed>
modifyCompanyAction() : array<string|int, mixed>
modifyExternalDateAction() : array<string|int, mixed>
modifyExternalIdAction() : array<string|int, mixed>
modifyInitiatedByTypeAction() : array<string|int, mixed>
modifyInitiatorAction() : array<string|int, mixed>
modifyIntegrationIdAction() : array<string|int, mixed>
modifyLangIdAction() : array<string|int, mixed>
modifyRegionDocumentTypeAction() : array<string|int, mixed>
modifySchemeAction() : array<string|int, mixed>
modifyTitleAction() : array<string|int, mixed>
redirectTo() : Redirect: Redirect to URL.
refreshEntityNumberAction() : array<string|int, mixed>
registerAction() : array<string|int, mixed>
removeAction() : array<string|int, mixed>
run() : HttpResponse|mixed
setCurrentUser() : void
setScope() : Controller
setSourceParametersList() : Controller
uploadAction() : array<string|int, mixed>

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

SCOPE_AJAX


    public
        mixed
    SCOPE_AJAX
    = 'ajax'

SCOPE_CLI


    public
        mixed
    SCOPE_CLI
    = 'cli'

SCOPE_REST


    public
        mixed
    SCOPE_REST
    = 'rest'

__construct()

Constructor Controller.


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

Parameters

$request : Request = null

changeBlankAction()


    public
                    changeBlankAction(string $uid, int $blankId) : array{uid: string}

Parameters

$uid : string
$blankId : int

#[LogicOr]: new Attribute\ActionAccess(permission: ActionDictionary::ACTION_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'uid'); new Attribute\ActionAccess(permission: ActionDictionary::ACTION_B2E_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'uid')

Return values

array{uid: string}

className()

Returns the fully qualified name of this class.


    public
        final    static        className() : string

Return values

string

configureAction()


    public
                    configureAction(string $uid) : array<string|int, mixed>

Parameters

$uid : string

#[LogicOr]: new Attribute\ActionAccess(permission: ActionDictionary::ACTION_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'uid'); new Attribute\ActionAccess(permission: ActionDictionary::ACTION_B2E_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'uid')

Return values

array<string|int, mixed>

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.

Return values

array<string|int, mixed>|mixed|string

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

Return values

HttpResponse|mixed

generateActionMethodName()


    public
        final            generateActionMethodName(mixed $action) : string

Parameters

$action : mixed

Return values

string

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

getAutoWiredParameters()


    public
                    getAutoWiredParameters() : array<string|int, Parameter>

Return values

array<string|int, Parameter>

getConfigurationOfActions()


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

Return values

array<string|int, mixed>|null

getCurrentUser()


    public
        final            getCurrentUser() : CurrentUser

Return values

CurrentUser

getDefaultAutoWiredParameters()


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

Return values

array<string|int, Parameter>

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>

getFillAndStartProgressAction()


    public
                    getFillAndStartProgressAction(string $uid) : array<string|int, mixed>

Parameters

$uid : string

#[LogicOr]: new Attribute\ActionAccess(permission: ActionDictionary::ACTION_DOCUMENT_READ, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'uid'); new Attribute\ActionAccess(permission: ActionDictionary::ACTION_B2E_DOCUMENT_READ, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'uid')

Return values

array<string|int, 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

getPrimaryAutoWiredParameter()


    public
                    getPrimaryAutoWiredParameter() : Parameter|null

Return values

Parameter|null

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

isNotAcceptedAgreement()


    public
                    isNotAcceptedAgreement() : bool

Return values

bool

listNameActions()

Returns list of all


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

Return values

array<string|int, mixed>

loadAction()


    public
                    loadAction(string $uid) : array<string|int, mixed>

Parameters

$uid : string

Tags

#[LogicOr]: new Attribute\ActionAccess(permission: ActionDictionary::ACTION_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'uid'); new Attribute\ActionAccess(permission: ActionDictionary::ACTION_B2E_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'uid')

Return values

array<string|int, mixed>

loadByIdAction()


    public
                    loadByIdAction(int $id) : array<string|int, mixed>

Parameters

$id : int

#[LogicOr]: new Attribute\ActionAccess(permission: ActionDictionary::ACTION_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'id'); new Attribute\ActionAccess(permission: ActionDictionary::ACTION_B2E_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'id')

Return values

array<string|int, mixed>

loadLanguageAction()


    public
                    loadLanguageAction() : array<string|int, mixed>

Return values

array<string|int, mixed>

modifyCompanyAction()


    public
                    modifyCompanyAction(string $documentUid, string $companyUid) : array<string|int, mixed>

Parameters

$documentUid : string
$companyUid : string

#[ActionAccess]: ActionDictionary::ACTION_B2E_DOCUMENT_EDIT; AccessibleItemType::DOCUMENT; $itemIdOrUidRequestKey: 'documentUid'

Return values

array<string|int, mixed>

modifyExternalDateAction()


    public
                    modifyExternalDateAction(string $uid, string $externalDate) : array<string|int, mixed>

Parameters

$uid : string
$externalDate : string

#[ActionAccess]: ActionDictionary::ACTION_B2E_DOCUMENT_EDIT; AccessibleItemType::DOCUMENT; $itemIdOrUidRequestKey: 'uid'

Return values

array<string|int, mixed>

modifyExternalIdAction()


    public
                    modifyExternalIdAction(string $uid, string $id) : array<string|int, mixed>

Parameters

$uid : string
$id : string

#[ActionAccess]: ActionDictionary::ACTION_B2E_DOCUMENT_EDIT; AccessibleItemType::DOCUMENT; $itemIdOrUidRequestKey: 'uid'

Return values

array<string|int, mixed>

modifyInitiatedByTypeAction()


    public
                    modifyInitiatedByTypeAction(string $uid, string $initiatedByType) : array<string|int, mixed>

Parameters

$uid : string
$initiatedByType : string

#[LogicOr]: new Attribute\ActionAccess(permission: ActionDictionary::ACTION_B2E_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'uid'); new Attribute\ActionAccess(permission: ActionDictionary::ACTION_B2E_TEMPLATE_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'uid')

Return values

array<string|int, mixed>

modifyInitiatorAction()


    public
                    modifyInitiatorAction(string $uid, string $initiator) : array<string|int, mixed>

Parameters

$uid : string
$initiator : string

Tags

#[LogicOr]: new Attribute\ActionAccess(permission: ActionDictionary::ACTION_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'uid'); new Attribute\ActionAccess(permission: ActionDictionary::ACTION_B2E_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'uid')

Return values

array<string|int, mixed>

modifyIntegrationIdAction()


    public
                    modifyIntegrationIdAction(string $uid[, int|null $integrationId = null ]) : array<string|int, mixed>

Parameters

$uid : string
$integrationId : int|null = null

#[LogicOr]: new Attribute\ActionAccess(ActionDictionary::ACTION_B2E_DOCUMENT_EDIT); new Attribute\ActionAccess(ActionDictionary::ACTION_B2E_TEMPLATE_EDIT)

Return values

array<string|int, mixed>

modifyLangIdAction()


    public
                    modifyLangIdAction(string $uid, string $langId) : array<string|int, mixed>

Parameters

$uid : string
$langId : string

Tags

#[LogicOr]: new Attribute\ActionAccess(permission: ActionDictionary::ACTION_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'uid'); new Attribute\ActionAccess(permission: ActionDictionary::ACTION_B2E_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'uid')

Return values

array<string|int, mixed>

modifyRegionDocumentTypeAction()


    public
                    modifyRegionDocumentTypeAction(string $uid, string $type) : array<string|int, mixed>

Parameters

$uid : string
$type : string

#[ActionAccess]: ActionDictionary::ACTION_B2E_DOCUMENT_EDIT; AccessibleItemType::DOCUMENT; $itemIdOrUidRequestKey: 'uid'

Return values

array<string|int, mixed>

modifySchemeAction()


    public
                    modifySchemeAction(string $uid, string $scheme) : array<string|int, mixed>

Parameters

$uid : string
$scheme : string

#[ActionAccess]: ActionDictionary::ACTION_B2E_DOCUMENT_EDIT; AccessibleItemType::DOCUMENT; $itemIdOrUidRequestKey: 'uid'

Return values

array<string|int, mixed>

modifyTitleAction()


    public
                    modifyTitleAction(string $uid, string $title) : array<string|int, mixed>

Parameters

$uid : string
$title : string

Tags

#[LogicOr]: new Attribute\ActionAccess(permission: ActionDictionary::ACTION_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'uid'); new Attribute\ActionAccess(permission: ActionDictionary::ACTION_B2E_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'uid')

Return values

array<string|int, mixed>

redirectTo()

Redirect to URL.


    public
                    redirectTo(string $url) : Redirect

Parameters

$url : string

Return values

Redirect

refreshEntityNumberAction()


    public
                    refreshEntityNumberAction(string $documentUid) : array<string|int, mixed>

Parameters

$documentUid : string

#[LogicOr]: new Attribute\ActionAccess(permission: ActionDictionary::ACTION_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'documentUid'); new Attribute\ActionAccess(permission: ActionDictionary::ACTION_B2E_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'documentUid')

Return values

array<string|int, mixed>

registerAction()


    public
                    registerAction(int $blankId[, string|null $scenarioType = null ][, bool $asTemplate = false ][, int $chatId = 0 ]) : array<string|int, mixed>

Parameters

$blankId : int
$scenarioType : string|null = null
$asTemplate : bool = false
$chatId : int = 0

#[LogicOr]: new Attribute\ActionAccess(ActionDictionary::ACTION_DOCUMENT_ADD); new Attribute\ActionAccess(ActionDictionary::ACTION_B2E_DOCUMENT_ADD); new Attribute\ActionAccess(ActionDictionary::ACTION_B2E_TEMPLATE_ADD)

Return values

array<string|int, mixed>

removeAction()


    public
                    removeAction(string $uid) : array<string|int, mixed>

Parameters

$uid : string

#[ActionAccess]: $permission: ActionDictionary::ACTION_B2E_DOCUMENT_EDIT; $itemType: AccessibleItemType::DOCUMENT; $itemIdOrUidRequestKey: 'uid'

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>

Return values

HttpResponse|mixed

setCurrentUser()


    public
        final            setCurrentUser(CurrentUser $currentUser) : void

Parameters

$currentUser : CurrentUser

setScope()


    public
        final            setScope(string $scope) : Controller

Parameters

$scope : string

Return values

Controller

setSourceParametersList()


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

Parameters

$sourceParametersList : array<string|int, mixed>

Return values

Controller

uploadAction()


    public
                    uploadAction(string $uid) : array<string|int, mixed>

Parameters

$uid : string

#[LogicOr]: new Attribute\ActionAccess(permission: ActionDictionary::ACTION_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'uid'); new Attribute\ActionAccess(permission: ActionDictionary::ACTION_B2E_DOCUMENT_EDIT, itemType: AccessibleItemType::DOCUMENT, itemIdOrUidRequestKey: 'uid')

Return values

array<string|int, mixed>

Document extends Controller

Table of Contents

Constants

Methods

Constants

ERROR_REQUIRED_PARAMETER

ERROR_UNKNOWN_ACTION

EVENT_ON_AFTER_ACTION

EVENT_ON_BEFORE_ACTION

EXCEPTION_UNKNOWN_ACTION

SCOPE_AJAX

SCOPE_CLI

SCOPE_REST

Methods

__construct()

Parameters

changeBlankAction()

Parameters

Attributes

Return values

className()

Return values

configureAction()

Parameters

Attributes

Return values

configureActions()

Return values

convertKeysToCamelCase()

Parameters

Tags

Return values

finalizeResponse()

Parameters

forward()

Parameters

Tags

Return values

generateActionMethodName()

Parameters

Return values

getActionUri()

Parameters

Return values

getAutoWiredParameters()

Return values

getConfigurationOfActions()

Return values

getCurrentUser()

Return values

getDefaultAutoWiredParameters()

Return values

getErrorByCode()

Parameters

Return values

getErrors()

Return values

getFillAndStartProgressAction()

Parameters

Attributes

Return values

getFullEventName()

Parameters

Return values

getModuleId()

Return values

getPrimaryAutoWiredParameter()

Return values

getRequest()

Return values

getScope()

Return values

getSourceParametersList()

Return values

getUnsignedParameters()

isLocatedUnderPsr4()

Return values

isNotAcceptedAgreement()

Return values

listNameActions()