Bitrix API

ApplyPublic extends Action implements ITimeLimit, IProcessParameters uses Stepper, ProcessParams

Harvester of the lang folder disposition.

Table of Contents

Interfaces

ITimeLimit
IProcessParameters
Manages process session parameters.

Constants

SOURCE_FOLDERS  = ['component' => '/install/components/bitrix', 'activities' => '/install/activities/bitrix', 'gadgets' => '/install/gadgets/bitrix', 'wizards' => '/install/wizards/bitrix', 'blocks' => '/install/blocks/bitrix', 'template' => '/install/templates', 'mobileapp' => '/install/mobileapp', 'js' => '/install/js']
TARGET_FOLDERS  = ['component' => '#BX_ROOT#/components/bitrix', 'activities' => '#BX_ROOT#/activities/bitrix', 'gadgets' => '#BX_ROOT#/gadgets/bitrix', 'wizards' => '#BX_ROOT#/wizards/bitrix', 'blocks' => '#BX_ROOT#/blocks/bitrix', 'template' => '#BX_ROOT#/templates', 'mobileapp' => '#BX_ROOT#/mobileapp', 'js' => '#BX_ROOT#/js']

Properties

$documentRoot  : string
$enabledLanguages  : array<string|int, string>
$translationRepositoryRoot  : string
$useTranslationRepository  : bool

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.
getArguments()  : array<string|int, mixed>
Returns list of action arguments.
getBinder()  : Binder
getConfig()  : array<string|int, mixed>
getController()  : Controller
getCurrentUser()  : mixed
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.
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.

Constants

SOURCE_FOLDERS

public mixed SOURCE_FOLDERS = ['component' => '/install/components/bitrix', 'activities' => '/install/activities/bitrix', 'gadgets' => '/install/gadgets/bitrix', 'wizards' => '/install/wizards/bitrix', 'blocks' => '/install/blocks/bitrix', 'template' => '/install/templates', 'mobileapp' => '/install/mobileapp', 'js' => '/install/js']

TARGET_FOLDERS

public mixed TARGET_FOLDERS = ['component' => '#BX_ROOT#/components/bitrix', 'activities' => '#BX_ROOT#/activities/bitrix', 'gadgets' => '#BX_ROOT#/gadgets/bitrix', 'wizards' => '#BX_ROOT#/wizards/bitrix', 'blocks' => '#BX_ROOT#/blocks/bitrix', 'template' => '#BX_ROOT#/templates', 'mobileapp' => '#BX_ROOT#/mobileapp', 'js' => '#BX_ROOT#/js']

Properties

$enabledLanguages

public static array<string|int, string> $enabledLanguages

$translationRepositoryRoot

public static string $translationRepositoryRoot

$useTranslationRepository

public static bool $useTranslationRepository

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.

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

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

restoreProgressParameters()

Restore progress state of the instance.

public restoreProgressParameters() : self
Return values
self

run()

Runs controller action.

public run() : array<string|int, mixed>
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