Bitrix API

DocumentService extends Controller

FinalYes

Table of Contents

Constants

ERROR_COULD_NOT_FIND_OBJECT  = 'DISK_C_22001'
ERROR_COULD_NOT_FIND_VERSION  = 'DISK_C_22005'
ERROR_COULD_NOT_UPDATE_FILE  = 'DISK_C_22006'
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.
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.
downloadDocumentAction()  : HttpResponse
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>
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.
getFullEventName()  : string
getModuleId()  : string
Returns module id.
getPrimaryAutoWiredParameter()  : Parameter|null
getRequest()  : HttpRequest
getScope()  : string
getSourceParametersList()  : array<string|int, mixed>
getUnsignedParameters()  : mixed
goToCreateAction()  : mixed
goToEditAction()  : mixed
goToEditOrPreviewAction()  : mixed
goToPreviewAction()  : mixed
isLocatedUnderPsr4()  : bool
listNameActions()  : array<string|int, mixed>
Returns list of all
loveAction()  : HttpResponse
It's fake love action to show user blank page on current domain. It's necessary to work with postMessage on IE11. So we use this action while running edit of documents.
redirectTo()  : Redirect
Redirect to URL.
restoreDocumentInteractionAction()  : mixed
run()  : HttpResponse|mixed
setCurrentUser()  : void
setScope()  : Controller
setSourceParametersList()  : Controller
setStatusWorkWithLocalDocumentAction()  : mixed
viewDocumentAction()  : HttpResponse

Constants

ERROR_COULD_NOT_FIND_OBJECT

public mixed ERROR_COULD_NOT_FIND_OBJECT = 'DISK_C_22001'

ERROR_COULD_NOT_FIND_VERSION

public mixed ERROR_COULD_NOT_FIND_VERSION = 'DISK_C_22005'

ERROR_COULD_NOT_UPDATE_FILE

public mixed ERROR_COULD_NOT_UPDATE_FILE = 'DISK_C_22006'

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

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

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

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>

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>

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

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

goToCreateAction()

public goToCreateAction(mixed $serviceCode, mixed $typeFile[, mixed $attachedObjectId = null ][, mixed $targetFolderId = null ]) : mixed
Parameters
$serviceCode : mixed
$typeFile : mixed
$attachedObjectId : mixed = null
$targetFolderId : mixed = null

goToEditAction()

public goToEditAction(mixed $serviceCode[, mixed $attachedObjectId = null ][, mixed $objectId = null ][, mixed $documentSessionId = null ]) : mixed
Parameters
$serviceCode : mixed
$attachedObjectId : mixed = null
$objectId : mixed = null
$documentSessionId : mixed = null

goToEditOrPreviewAction()

public goToEditOrPreviewAction(mixed $serviceCode[, mixed $attachedObjectId = null ][, mixed $objectId = null ][, mixed $versionId = null ]) : mixed
Parameters
$serviceCode : mixed
$attachedObjectId : mixed = null
$objectId : mixed = null
$versionId : mixed = null

goToPreviewAction()

public goToPreviewAction(mixed $serviceCode[, mixed $attachedObjectId = null ][, mixed $objectId = null ][, mixed $versionId = null ]) : mixed
Parameters
$serviceCode : mixed
$attachedObjectId : mixed = null
$objectId : mixed = null
$versionId : mixed = null

isLocatedUnderPsr4()

public final isLocatedUnderPsr4() : bool
Return values
bool

listNameActions()

Returns list of all

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

loveAction()

It's fake love action to show user blank page on current domain. It's necessary to work with postMessage on IE11. So we use this action while running edit of documents.

public loveAction() : HttpResponse
Return values
HttpResponse

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

setStatusWorkWithLocalDocumentAction()

public setStatusWorkWithLocalDocumentAction(mixed $uidRequest, mixed $status) : mixed
Parameters
$uidRequest : mixed
$status : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results