Bitrix API

DocumentController extends DocumentController

FinalYes

Table of Contents

Constants

ERROR_BAD_RIGHTS  = 'DISK_DOC_CON_22002'
ERROR_COULD_NOT_ADD_VERSION  = 'DISK_DOC_CON_22009'
ERROR_COULD_NOT_CREATE_FILE  = 'DISK_DOC_CON_22014'
ERROR_COULD_NOT_FIND_ATTACHED_OBJECT  = 'DISK_UFDOCC_22001'
ERROR_COULD_NOT_FIND_DELETE_SESSION  = 'DISK_DOC_CON_22010'
ERROR_COULD_NOT_FIND_EDIT_SESSION  = 'DISK_DOC_CON_22007'
ERROR_COULD_NOT_FIND_FILE  = 'DISK_DOC_CON_22005'
ERROR_COULD_NOT_FIND_FOLDER_FOR_CREATED_FILES  = 'DISK_DOC_CON_22013'
ERROR_COULD_NOT_FIND_STORAGE  = 'DISK_DOC_CON_22012'
ERROR_COULD_NOT_FIND_VERSION  = 'DISK_DOC_CON_22006'
ERROR_COULD_NOT_GET_FILE  = 'DISK_DOC_CON_22011'
ERROR_COULD_NOT_SAVE_FILE  = 'DISK_DOC_CON_22008'
ERROR_COULD_NOT_WORK_WITH_TOKEN_SERVICE  = 'DISK_DOC_CON_22004'
ERROR_REQUIRED_PARAMETER  = 'DISK_CONTROLLER_22001'
ERROR_UNKNOWN_ACTION  = 'DISK_CONTROLLER_22002'
ERROR_UNKNOWN_HANDLER  = 'DISK_DOC_CON_22003'
EVENT_ON_BEFORE_ACTION  = 'onBeforeAction'
STATUS_DENIED  = 'denied'
STATUS_ERROR  = 'error'
STATUS_INVALID_SIGN  = 'invalid_sign'
STATUS_NEED_AUTH  = 'need_auth'
STATUS_RESTRICTION  = 'restriction'
STATUS_SUCCESS  = 'success'

Methods

__construct()  : mixed
Constructor Controller.
exec()  : void
Executes controller by specific action.
getAction()  : string
Gets current action.
getActionDescription()  : array<string|int, mixed>
Gets description of action.
getDocumentHandlerName()  : string
getErrorByCode()  : array<string|int, Error>
Getting once error with the necessary code.
getErrors()  : array<string|int, Error>
Getting array of errors.
getErrorsByCode()  : array<string|int, Error>
Getting array of errors with the necessary code.
setAction()  : $this
Sets action and description.
setActionName()  : $this
Sets action name.
setDocumentHandlerName()  : $this
Sets document handler name.

Constants

ERROR_COULD_NOT_ADD_VERSION

public mixed ERROR_COULD_NOT_ADD_VERSION = 'DISK_DOC_CON_22009'

ERROR_COULD_NOT_CREATE_FILE

public mixed ERROR_COULD_NOT_CREATE_FILE = 'DISK_DOC_CON_22014'

ERROR_COULD_NOT_FIND_ATTACHED_OBJECT

public mixed ERROR_COULD_NOT_FIND_ATTACHED_OBJECT = 'DISK_UFDOCC_22001'

ERROR_COULD_NOT_FIND_DELETE_SESSION

public mixed ERROR_COULD_NOT_FIND_DELETE_SESSION = 'DISK_DOC_CON_22010'

ERROR_COULD_NOT_FIND_EDIT_SESSION

public mixed ERROR_COULD_NOT_FIND_EDIT_SESSION = 'DISK_DOC_CON_22007'

ERROR_COULD_NOT_FIND_FILE

public mixed ERROR_COULD_NOT_FIND_FILE = 'DISK_DOC_CON_22005'

ERROR_COULD_NOT_FIND_FOLDER_FOR_CREATED_FILES

public mixed ERROR_COULD_NOT_FIND_FOLDER_FOR_CREATED_FILES = 'DISK_DOC_CON_22013'

ERROR_COULD_NOT_FIND_STORAGE

public mixed ERROR_COULD_NOT_FIND_STORAGE = 'DISK_DOC_CON_22012'

ERROR_COULD_NOT_FIND_VERSION

public mixed ERROR_COULD_NOT_FIND_VERSION = 'DISK_DOC_CON_22006'

ERROR_COULD_NOT_GET_FILE

public mixed ERROR_COULD_NOT_GET_FILE = 'DISK_DOC_CON_22011'

ERROR_COULD_NOT_SAVE_FILE

public mixed ERROR_COULD_NOT_SAVE_FILE = 'DISK_DOC_CON_22008'

ERROR_COULD_NOT_WORK_WITH_TOKEN_SERVICE

public mixed ERROR_COULD_NOT_WORK_WITH_TOKEN_SERVICE = 'DISK_DOC_CON_22004'

ERROR_REQUIRED_PARAMETER

public mixed ERROR_REQUIRED_PARAMETER = 'DISK_CONTROLLER_22001'

ERROR_UNKNOWN_ACTION

public mixed ERROR_UNKNOWN_ACTION = 'DISK_CONTROLLER_22002'

EVENT_ON_BEFORE_ACTION

public mixed EVENT_ON_BEFORE_ACTION = 'onBeforeAction'

STATUS_DENIED

public mixed STATUS_DENIED = 'denied'

STATUS_ERROR

public mixed STATUS_ERROR = 'error'

STATUS_INVALID_SIGN

public mixed STATUS_INVALID_SIGN = 'invalid_sign'

STATUS_NEED_AUTH

public mixed STATUS_NEED_AUTH = 'need_auth'

STATUS_RESTRICTION

public mixed STATUS_RESTRICTION = 'restriction'

STATUS_SUCCESS

public mixed STATUS_SUCCESS = 'success'

Methods

__construct()

Constructor Controller.

public __construct() : mixed

exec()

Executes controller by specific action.

public exec() : void

This method contains all steps of life cycle controller.

getAction()

Gets current action.

public getAction() : string
Return values
string

getActionDescription()

Gets description of action.

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

getDocumentHandlerName()

public getDocumentHandlerName() : string
Return values
string

getErrorByCode()

Getting once error with the necessary code.

public getErrorByCode(string $code) : array<string|int, Error>
Parameters
$code : string

Code of error.

Return values
array<string|int, Error>

getErrors()

Getting array of errors.

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

getErrorsByCode()

Getting array of errors with the necessary code.

public getErrorsByCode(string $code) : array<string|int, Error>
Parameters
$code : string

Code of error.

Return values
array<string|int, Error>

setAction()

Sets action and description.

public setAction(string $action, array<string|int, mixed> $description) : $this
Parameters
$action : string

Action name.

$description : array<string|int, mixed>

Action description.

Return values
$this

setActionName()

Sets action name.

public setActionName(string $action) : $this
Parameters
$action : string

Action name.

Return values
$this

setDocumentHandlerName()

Sets document handler name.

public setDocumentHandlerName(string $serviceName) : $this
Parameters
$serviceName : string

Document handler name.

Return values
$this

        
On this page

Search results