Bitrix API

ExportPath extends ExportAction implements ITimeLimit, IProcessParameters uses Stepper, ProcessParams

Harvester of phrases the list of files and folders.

Table of Contents

Interfaces

ITimeLimit
IProcessParameters
Manages process session parameters.

Methods

__construct()  : mixed
\Bitrix\Main\Engine\Action constructor.
className()  : string
Returns the fully qualified name of this class.
clearProgressParameters()  : self
Removes progress parameters.
configure()  : void
Configures action by additional params.
convertKeysToCamelCase()  : array<string|int, mixed>|mixed|string
Converts keys of array to camel case notation.
declareAccomplishment()  : void
Switch accomplishment flag of the process.
findSamples()  : array<string|int, mixed>
Looks for exact translation sample of the phrase.
getArguments()  : array<string|int, mixed>
Returns list of action arguments.
getBinder()  : Binder
getConfig()  : array<string|int, mixed>
getController()  : Controller
getCurrentUser()  : mixed
getDownloadingParameters()  : array<string|int, mixed>
Returns exported file properties.
getDownloadingSamplesParameters()  : array<string|int, mixed>
Returns exported file properties.
getErrorByCode()  : Error
Getting once error with the necessary code.
getErrors()  : array<string|int, Error>
Getting array of errors.
getName()  : string
getProgressParameterOptionName()  : string
Returns progress option name
getProgressParameters()  : array<string|int, mixed>
Load progress parameters.
hasErrors()  : bool
Getting array of errors.
hasProcessCompleted()  : bool
Tells true if process has completed.
hasTimeLimitReached()  : bool
Tells true if time limit reached.
instanceTimer()  : Timer
Gets timer.
keepField()  : self
Tells if needed to keep field state as progress parameters.
lookThroughLangFolder()  : Generator|array<string|int, mixed>|iterable<string|int, mixed>
Runs through lang folder and collects full path to lang files.
mergeLangFiles()  : array<string|int, mixed>
Merges all language files into one array.
restoreProgressParameters()  : self
Restore progress state of the instance.
run()  : array<string|int, mixed>
Runs controller action.
runWithSourceParametersList()  : mixed
saveProgressParameters()  : self
Save progress parameters.
setArguments()  : Binder
Sets list of action arguments.
startTimer()  : void
Sets start up time.

Methods

__construct()

\Bitrix\Main\Engine\Action constructor.

public __construct(string $name, Controller $controller[, array<string|int, mixed> $config = [] ]) : mixed
Parameters
$name : string

Action name.

$controller : Controller

Parent controller object.

$config : array<string|int, mixed> = []

Additional configuration.

className()

Returns the fully qualified name of this class.

public final static className() : string
Return values
string

clearProgressParameters()

Removes progress parameters.

public clearProgressParameters() : self
Return values
self

configure()

Configures action by additional params.

public configure(mixed $params) : void

The method will be invoked by controller and $params have to set in 'configureActions'

Parameters
$params : 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

declareAccomplishment()

Switch accomplishment flag of the process.

public declareAccomplishment([bool $flag = true ]) : void
Parameters
$flag : bool = true

Accomplishment flag value.

findSamples()

Looks for exact translation sample of the phrase.

public findSamples(string $searchPhrase, string $searchLangId, int|string $stripPath[, int $limit = 50 ][, array<string|int, int> $restrictByPathId = [] ]) : array<string|int, mixed>
Parameters
$searchPhrase : string

Phrase to look for.

$searchLangId : string

Phrase lang to look for.

$stripPath : int|string

Strip current file.

$limit : int = 50

Limit search result.

$restrictByPathId : array<string|int, int> = []
Return values
array<string|int, mixed>

getArguments()

Returns list of action arguments.

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

It is associative array looks like argument name => value.

Tags
throws
SystemException
Return values
array<string|int, mixed>

getConfig()

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

getCurrentUser()

public final getCurrentUser() : mixed

getDownloadingParameters()

Returns exported file properties.

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

getDownloadingSamplesParameters()

Returns exported file properties.

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

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>

getName()

public final getName() : string
Return values
string

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>

hasErrors()

Getting array of errors.

public hasErrors() : bool
Return values
bool

hasProcessCompleted()

Tells true if process has completed.

public hasProcessCompleted() : bool
Return values
bool

hasTimeLimitReached()

Tells true if time limit reached.

public hasTimeLimitReached() : bool
Tags
see
ITimeLimit
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

lookThroughLangFolder()

Runs through lang folder and collects full path to lang files.

public lookThroughLangFolder(string $langPath) : Generator|array<string|int, mixed>|iterable<string|int, mixed>
Parameters
$langPath : string

Relative project path of the language folder.

Return values
Generator|array<string|int, mixed>|iterable<string|int, mixed>

mergeLangFiles()

Merges all language files into one array.

public mergeLangFiles(string $langFilePath, array<string|int, string> $fullLangFilePaths[, bool $collectUntranslated = false ][, array<string|int, string> $filterByCodeList = [] ]) : array<string|int, mixed>
Parameters
$langFilePath : string

Relative project path of the language file.

$fullLangFilePaths : array<string|int, string>

Array of full paths to lang files.

$collectUntranslated : bool = false

Collect only untranslated phrases.

$filterByCodeList : array<string|int, string> = []

Array of prase codes to filter.

Return values
array<string|int, mixed>

restoreProgressParameters()

Restore progress state of the instance.

public restoreProgressParameters() : self
Return values
self

run()

Runs controller action.

public run([string $path = '' ][, bool $runBefore = false ]) : array<string|int, mixed>
Parameters
$path : string = ''

Path to export.

$runBefore : bool = false

Flag to run onBeforeRun event handler.

Return values
array<string|int, mixed>

runWithSourceParametersList()

public runWithSourceParametersList() : mixed

saveProgressParameters()

Save progress parameters.

public saveProgressParameters() : self
Return values
self

setArguments()

Sets list of action arguments.

public final setArguments(array<string|int, mixed> $arguments) : Binder

It is associative array looks like argument name => value. Be aware the method reset old values and set new arguments.

Parameters
$arguments : array<string|int, mixed>

List of action arguments.

Tags
throws
SystemException
Return values
Binder 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results