Bitrix API

Csv extends Controller implements IProcessParameters uses ProcessParams

Interfaces

IProcessParameters: Manages process session parameters.

Constants

ACTION_CANCEL = 'cancel'
ACTION_CLEAR = 'clear'
ACTION_DOWNLOAD = 'download'
ACTION_EXPORT = 'export'
ACTION_EXPORT_FILE = 'exportFile'
ACTION_EXPORT_FILE_LIST = 'exportFileList'
ACTION_EXPORT_FILE_SEARCH = 'exportFileSearch'
ACTION_EXPORT_PATH = 'exportPath'
ACTION_EXPORT_PHRASE_SEARCH = 'exportPhraseSearch'
ACTION_PURGE = 'purge'
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_EXPORT'

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.
exportAction() : array<string|int, mixed>: Runs controller action.
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
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

ACTION_CANCEL


    public
        mixed
    ACTION_CANCEL
    = 'cancel'

ACTION_CLEAR


    public
        mixed
    ACTION_CLEAR
    = 'clear'

ACTION_DOWNLOAD


    public
        mixed
    ACTION_DOWNLOAD
    = 'download'

ACTION_EXPORT


    public
        mixed
    ACTION_EXPORT
    = 'export'

ACTION_EXPORT_FILE


    public
        mixed
    ACTION_EXPORT_FILE
    = 'exportFile'

ACTION_EXPORT_FILE_LIST


    public
        mixed
    ACTION_EXPORT_FILE_LIST
    = 'exportFileList'

ACTION_EXPORT_FILE_SEARCH


    public
        mixed
    ACTION_EXPORT_FILE_SEARCH
    = 'exportFileSearch'

ACTION_EXPORT_PATH


    public
        mixed
    ACTION_EXPORT_PATH
    = 'exportPath'

ACTION_EXPORT_PHRASE_SEARCH


    public
        mixed
    ACTION_EXPORT_PHRASE_SEARCH
    = 'exportPhraseSearch'

ACTION_PURGE


    public
        mixed
    ACTION_PURGE
    = 'purge'

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'

SETTING_ID


    public
        mixed
    SETTING_ID
    = 'TRANSLATE_EXPORT'

__construct()

Constructor Controller.


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

Parameters

$request : Request|null = null

cancelAction()

Deletes generated file.


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

Parameters

$tabId : int: Id of session storage.

Return values

array<string|int, mixed>

className()

Returns the fully qualified name of this class.


    public
        final    static        className() : string

Return values

string

clearAction()

Deletes generated file.


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

Parameters

$tabId : int: Id of session storage.

Return values

array<string|int, mixed>

clearProgressParameters()

Removes progress parameters.


    public
                    clearProgressParameters() : self

Return values

self

configureActions()

Configures actions.


    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

downloadAction()

Starts downloading genereted file.


    public
                    downloadAction(int $tabId, string $type) : HttpResponse|void

Parameters

$tabId : int: Id of session storage.
$type : string

Return values

HttpResponse|void

exportAction()

Runs controller action.


    public
                    exportAction(int $tabId[, string $path = '' ]) : array<string|int, mixed>

Parameters

$tabId : int: Id of session storage.
$path : string = '': Path to indexing.

Return values

array<string|int, mixed>

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>

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

getProgressParameterOptionName()

Returns progress option name


    public
                    getProgressParameterOptionName() : string

Return values

string

getProgressParameters()

Load progress parameters.


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

Return values

array<string|int, mixed>

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

hasErrors()

Checks if error occurred.


    public
                    hasErrors() : bool

Return values

bool

isLocatedUnderPsr4()


    public
        final            isLocatedUnderPsr4() : bool

Return values

bool

keepField()

Tells if needed to keep field state as progress parameters.


    public
                    keepField(string|array<string|int, string> $fieldName) : self

Parameters

$fieldName : string|array<string|int, string>: Name of instance field to keep in progress parameters.

Return values

self

listNameActions()

Returns list of all


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

Return values

array<string|int, mixed>

purgeAction()

Deletes generated file.


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

Parameters

$tabId : int: Id of session storage.

Return values

array<string|int, mixed>

redirectTo()

Redirect to URL.


    public
                    redirectTo(string $url) : Redirect

Parameters

$url : string

Return values

Redirect

restoreProgressParameters()

Restore progress state of the instance.


    public
                    restoreProgressParameters() : self

Return values

self

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

saveProgressParameters()

Save progress parameters.


    public
                    saveProgressParameters() : self

Return values

self

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

Csv extends Controller implements IProcessParameters uses ProcessParams

Table of Contents

Interfaces

Constants

Methods

Constants

ACTION_CANCEL

ACTION_CLEAR

ACTION_DOWNLOAD

ACTION_EXPORT

ACTION_EXPORT_FILE

ACTION_EXPORT_FILE_LIST

ACTION_EXPORT_FILE_SEARCH

ACTION_EXPORT_PATH

ACTION_EXPORT_PHRASE_SEARCH

ACTION_PURGE

ERROR_REQUIRED_PARAMETER

ERROR_UNKNOWN_ACTION

EVENT_ON_AFTER_ACTION

EVENT_ON_BEFORE_ACTION

EXCEPTION_UNKNOWN_ACTION

SCOPE_AJAX

SCOPE_CLI

SCOPE_REST

SETTING_ID

Methods

__construct()

Parameters

cancelAction()

Parameters

Tags

Return values

className()

Return values

clearAction()

Parameters

Tags

Return values

clearProgressParameters()

Return values

configureActions()

Return values

convertKeysToCamelCase()

Parameters

Tags

Return values

downloadAction()

Parameters

Tags

Return values

exportAction()

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

getFullEventName()