Bitrix API

Grabber extends Controller implements IProcessParameters uses ProcessParams

Table of Contents

Interfaces

IProcessParameters

Manages process session parameters.

Constants

ACTION_APPLY  = 'apply'

ACTION_APPLY_PUBLIC  = 'apply_public'

ACTION_CANCEL  = 'cancel'

ACTION_CLEAR  = 'clear'

ACTION_COLLECT  = 'collect'

ACTION_DOWNLOAD  = 'download'

ACTION_EXTRACT  = 'extract'

ACTION_FINALIZE  = 'finalize'

ACTION_PACK  = 'pack'

ACTION_PURGE  = 'purge'

ACTION_UPLOAD  = 'upload'

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'

SETTING_ID  = 'TRANSLATE_LANGPACK'

START_PATH  = '/bitrix/modules'

Methods

__construct()  : mixed

Constructor Controller.

cancelAction()  : array<string|int, mixed>

Deletes generated file.

className()  : string

Returns the fully qualified name of this class.

clearAction()  : array<string|int, mixed>

Deletes generated file.

clearProgressParameters()  : self

Removes progress parameters.

configureActions()  : array<string|int, mixed>

Configures actions.

convertKeysToCamelCase()  : array<string|int, mixed>|mixed|string

Converts keys of array to camel case notation.

downloadAction()  : HttpResponse|void

Starts downloading genereted file.

finalizeAction()  : array<string|int, mixed>

Deletes temporal folder and files.

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.

getFullEventName()  : string

getMaxUploadSize()  : int

Gets actual maximum upload size.

getModuleId()  : string

Returns module id.

getPrimaryAutoWiredParameter()  : Parameter|null

getProgressParameterOptionName()  : string

Returns progress option name

getProgressParameters()  : array<string|int, mixed>

Load progress parameters.

getRequest()  : HttpRequest

getScope()  : string

getSourceParametersList()  : array<string|int, mixed>

getUnsignedParameters()  : mixed

hasErrors()  : bool

Checks if error occurred.

isLocatedUnderPsr4()  : bool

keepField()  : self

Tells if needed to keep field state as progress parameters.

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

Returns list of all

purgeAction()  : array<string|int, mixed>

Deletes generated file.

redirectTo()  : Redirect

Redirect to URL.

restoreProgressParameters()  : self

Restore progress state of the instance.

run()  : HttpResponse|mixed

saveProgressParameters()  : self

Save progress parameters.

setCurrentUser()  : void

setScope()  : Controller

setSourceParametersList()  : Controller

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

Handles uploaded file.