Класс Action

Граф наследования:Action:

Открытые члены
	__construct ($name, Controller $controller, $config=array())
	configure ($params)
	getArguments ()
	setArguments (array $arguments)
	runWithSourceParametersList ()
	getBinder ()
	getController ()
	getName ()
	getConfig ()
	getCurrentUser ()
	convertKeysToCamelCase ($data)
	getErrors ()
	getErrorByCode ($code)

Открытые статические члены
static	className ()

Защищенные члены
	init ()
	buildBinder ()
	onBeforeRun ()
	onAfterRun ()
	addError (Error $error)
	addErrors (array $errors)

Защищенные данные
	$binder
	$errorCollection
	$controller
	$config
	$name

Подробное описание

См. определение в файле action.php строка 16

Конструктор(ы)

__construct()

__construct	(		$name,
		Controller	$controller,
			$config = array() )

Переопределяется в FallbackAction и InlineAction.

См. определение в файле action.php строка 29

Методы

addError()

addError ( Error $error )

protected

Adds error to error collection.

Аргументы

Error

$error

Error.

Возвращает

$this

См. определение в файле action.php строка 200

addErrors()

addErrors ( array $errors )

protected

Adds list of errors to error collection.

Аргументы

Error[]

$errors

Errors.

Возвращает

$this

См. определение в файле action.php строка 213

buildBinder()

buildBinder ( )

protected

Переопределяется в ClosureAction, InlineAction, FallbackAction и InlineAction.

См. определение в файле action.php строка 86

className()

static className ( )

staticfinal

Returns the fully qualified name of this class.

Возвращает

string

См. определение в файле action.php строка 189

configure()

configure

(

$params

)

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

Аргументы

$params

Возвращает

void

См. определение в файле action.php строка 50

convertKeysToCamelCase()

convertKeysToCamelCase

(

$data

)

Converts keys of array to camel case notation.

См. также

\Bitrix\Main\Engine\Response\Converter::OUTPUT_JSON_FORMAT

Аргументы

mixed

$data

Data.

Возвращает

array|mixed|string

См. определение в файле action.php строка 180

getArguments()

getArguments ( )

final

Returns list of action arguments. It is associative array looks like argument name => value.

Возвращает

array

Исключения

SystemException

См. определение в файле action.php строка 62

getBinder()

getBinder ( )

final

Возвращает

AutoWire\Binder

См. определение в файле action.php строка 130

getConfig()

getConfig ( )

final

Возвращает

array

См. определение в файле action.php строка 154

getController()

getController ( )

final

Возвращает

Controller

См. определение в файле action.php строка 138

getCurrentUser()

getCurrentUser ( )

final

См. определение в файле action.php строка 168

getErrorByCode()

getErrorByCode ( $code )

final

Getting once error with the necessary code.

Аргументы

string

$code

Code of error.

Возвращает

Error

Замещает Errorable.

См. определение в файле action.php строка 234

getErrors()

getErrors ( )

final

Getting array of errors.

Возвращает

Error[]

Замещает Errorable.

См. определение в файле action.php строка 224

getName()

getName ( )

final

Возвращает

string

См. определение в файле action.php строка 146

init()

init ( )

protected

См. определение в файле action.php строка 53

onAfterRun()

onAfterRun ( )

protected

См. определение в файле action.php строка 164

onBeforeRun()

onBeforeRun ( )

protected

Переопределяется в BaseAction и BaseAction.

См. определение в файле action.php строка 159

runWithSourceParametersList()

runWithSourceParametersList

(

)

См. также

Action::run

Переопределяется в InlineAction, BaseAction и BaseAction.

См. определение в файле action.php строка 111

setArguments()

setArguments ( array $arguments )

final

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

Аргументы

array

$arguments

List of action arguments.

Возвращает

AutoWire\Binder

Исключения

SystemException

См. определение в файле action.php строка 79

Данные класса

$binder

$binder

protected

См. определение в файле action.php строка 19

$config

$config

protected

См. определение в файле action.php строка 25

$controller

$controller

protected

См. определение в файле action.php строка 23

$errorCollection

$errorCollection

protected

См. определение в файле action.php строка 21

$name

$name

protected

См. определение в файле action.php строка 27