Bitrix API

StorageController extends Controller

Table of Contents

Constants

COOKIE_DISK_USAGE  = 'DISK_BDISK_USAGE'
ERROR_CREATE_FORK_FILE  = 'SC_FF_22001'
ERROR_REQUIRED_PARAMETER  = 'DISK_CONTROLLER_22001'
ERROR_UNKNOWN_ACTION  = 'DISK_CONTROLLER_22002'
EVENT_ON_AFTER_DISK_FILE_ADD  = 'OnAfterDiskFileAdd'
EVENT_ON_AFTER_DISK_FILE_DELETE  = 'OnAfterDiskFileDelete'
EVENT_ON_AFTER_DISK_FILE_UPDATE  = 'OnAfterDiskFileUpdate'
EVENT_ON_AFTER_DISK_FIRST_USAGE_BY_DAY  = 'OnAfterDiskFirstUsageByDay'
EVENT_ON_AFTER_DISK_FOLDER_ADD  = 'OnAfterDiskFolderAdd'
EVENT_ON_AFTER_DISK_FOLDER_DELETE  = 'OnAfterDiskFolderDelete'
EVENT_ON_AFTER_DISK_FOLDER_UPDATE  = 'OnAfterDiskFolderUpdate'
EVENT_ON_BEFORE_ACTION  = 'onBeforeAction'
MIN_API_DISK_VERSION  = 29
MIN_API_DISK_VERSION_FOR_JSON_LIST_IN_SNAPSHOT  = 74
MIN_API_DISK_VERSION_FOR_NEW_SNAPSHOT  = 37
STATUS_ACCESS_DENIED  = 'access_denied'
STATUS_CHUNK_ERROR  = 'chunk_error'
STATUS_DENIED  = 'denied'
STATUS_ERROR  = 'error'
STATUS_ERROR_TOKEN_SID  = 'error_token_sid'
STATUS_INVALID_SIGN  = 'invalid_sign'
STATUS_LIMITED  = 'limited'
STATUS_LOCKED  = 'locked'
STATUS_NEED_AUTH  = 'need_auth'
STATUS_NO_SPACE  = 'no_space'
STATUS_NON_UNIQUE_NAME  = 'non_unique_name'
STATUS_NOT_FOUND  = 'not_found'
STATUS_OLD_VERSION  = 'old_version'
STATUS_RESTRICTION  = 'restriction'
STATUS_SUCCESS  = 'success'
STATUS_TOO_BIG  = 'too_big'
STATUS_TRY_LATER  = 'try_later'
STATUS_UNLIMITED  = 'unlimited'
VERSION  = 920

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.
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.

Constants

ERROR_REQUIRED_PARAMETER

public mixed ERROR_REQUIRED_PARAMETER = 'DISK_CONTROLLER_22001'

ERROR_UNKNOWN_ACTION

public mixed ERROR_UNKNOWN_ACTION = 'DISK_CONTROLLER_22002'

EVENT_ON_AFTER_DISK_FILE_ADD

public mixed EVENT_ON_AFTER_DISK_FILE_ADD = 'OnAfterDiskFileAdd'

EVENT_ON_AFTER_DISK_FILE_DELETE

public mixed EVENT_ON_AFTER_DISK_FILE_DELETE = 'OnAfterDiskFileDelete'

EVENT_ON_AFTER_DISK_FILE_UPDATE

public mixed EVENT_ON_AFTER_DISK_FILE_UPDATE = 'OnAfterDiskFileUpdate'

EVENT_ON_AFTER_DISK_FIRST_USAGE_BY_DAY

public mixed EVENT_ON_AFTER_DISK_FIRST_USAGE_BY_DAY = 'OnAfterDiskFirstUsageByDay'

EVENT_ON_AFTER_DISK_FOLDER_ADD

public mixed EVENT_ON_AFTER_DISK_FOLDER_ADD = 'OnAfterDiskFolderAdd'

EVENT_ON_AFTER_DISK_FOLDER_DELETE

public mixed EVENT_ON_AFTER_DISK_FOLDER_DELETE = 'OnAfterDiskFolderDelete'

EVENT_ON_AFTER_DISK_FOLDER_UPDATE

public mixed EVENT_ON_AFTER_DISK_FOLDER_UPDATE = 'OnAfterDiskFolderUpdate'

EVENT_ON_BEFORE_ACTION

public mixed EVENT_ON_BEFORE_ACTION = 'onBeforeAction'

MIN_API_DISK_VERSION_FOR_JSON_LIST_IN_SNAPSHOT

public mixed MIN_API_DISK_VERSION_FOR_JSON_LIST_IN_SNAPSHOT = 74

MIN_API_DISK_VERSION_FOR_NEW_SNAPSHOT

public mixed MIN_API_DISK_VERSION_FOR_NEW_SNAPSHOT = 37

STATUS_DENIED

public mixed STATUS_DENIED = 'denied'

STATUS_ERROR

public mixed STATUS_ERROR = 'error'

STATUS_ERROR_TOKEN_SID

public mixed STATUS_ERROR_TOKEN_SID = 'error_token_sid'

STATUS_INVALID_SIGN

public mixed STATUS_INVALID_SIGN = 'invalid_sign'

STATUS_NEED_AUTH

public mixed STATUS_NEED_AUTH = 'need_auth'

STATUS_NON_UNIQUE_NAME

public mixed STATUS_NON_UNIQUE_NAME = 'non_unique_name'

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>

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

        
On this page

Search results