Operation extends Action
Common operation with language file.
Table of Contents
Properties
- $documentRoot : string
- $enabledLanguagesList : array<string|int, string>
Methods
- __construct() : mixed
- \Bitrix\Main\Engine\Action constructor.
- className() : string
- Returns the fully qualified name of this class.
- configure() : void
- Configures action by additional params.
- convertKeysToCamelCase() : array<string|int, mixed>|mixed|string
- Converts keys of array to camel case notation.
- 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
- hasErrors() : bool
- Checks if error occurred.
- runWithSourceParametersList() : mixed
- setArguments() : Binder
- Sets list of action arguments.
Properties
$documentRoot
public
static string
$documentRoot
$enabledLanguagesList
public
static array<string|int, string>
$enabledLanguagesList
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
stringconfigure()
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
Return values
array<string|int, mixed>|mixed|stringgetArguments()
Returns list of action arguments.
public
final getArguments() : array<string|int, mixed>
It is associative array looks like argument name => value.
Tags
Return values
array<string|int, mixed>getBinder()
public
final getBinder() : Binder
Return values
BindergetConfig()
public
final getConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>getController()
public
final getController() : Controller
Return values
ControllergetCurrentUser()
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
ErrorgetErrors()
Getting array of errors.
public
final getErrors() : array<string|int, Error>
Return values
array<string|int, Error>getName()
public
final getName() : string
Return values
stringhasErrors()
Checks if error occurred.
public
hasErrors() : bool
Return values
boolrunWithSourceParametersList()
public
runWithSourceParametersList() : mixed
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.