Открытые члены
	__construct ()

	exec ()

	getErrors ()

	getErrorByCode ($code)

	getAction ()

	getActionDescription ()

	setAction ($action, array $description)

	setActionName ($action)

Открытые атрибуты
const	EVENT_ON_BEFORE_ACTION = 'onBeforeAction'

const	ERROR_REQUIRED_PARAMETER = 'REPORT_CONTROLLER_22001'

const	ERROR_UNKNOWN_ACTION = 'REPORT_CONTROLLER_22002'

const	STATUS_SUCCESS = 'success'

const	STATUS_DENIED = 'denied'

const	STATUS_ERROR = 'error'

const	STATUS_NEED_AUTH = 'need_auth'

const	STATUS_INVALID_SIGN = 'invalid_sign'

const	STATUS_RESTRICTION = 'restriction'

Защищенные члены
	init ()

	end ()

	triggerOnBeforeAction ($action)

	getUser ()

	sendJsonResponse ($response, $params=null)

	sendJsonAccessDeniedResponse ($message='')

	sendJsonInvalidSignResponse ($message='')

	sendJsonSuccessResponse (array $response=array())

	sendResponse ($response)

	resolveAction ()

	normalizeListOfAction (array $listOfActions)

	normalizeActionDescription ($action, $description)

	checkAction ()

	listActions ()

	checkRequiredModules ()

	prepareParams ()

	processBeforeAction ($actionName)

	runAction ()

	runProcessingException (\Exception $e)

	runProcessingIfUserNotAuthorized ()

	runProcessingIfInvalidCsrfToken ()

	getApplication ()

	checkRequiredInputParams (array $inputParams, array $required)

	checkRequiredPostParams (array $required)

	checkRequiredGetParams (array $required)

	checkRequiredFilesParams (array $required)

	isAjaxRequest ()

Защищенные данные
	$action

	$actionDescription

	$realActionName

	$errorCollection

	$request

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

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

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

◆ __construct()

__construct ( )

Constructor Controller.

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

Методы

◆ checkAction()

checkAction ( )

protected

Checks action by settings in description. This method may terminate controller and application.

Возвращает: void

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

◆ checkRequiredFilesParams()

checkRequiredFilesParams ( array $required )

protected

Checks required parameters in $_FILES. Fills error collection if required parameter is missed.

Аргументы

array $required Required parameters.

Возвращает: bool

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

◆ checkRequiredGetParams()

checkRequiredGetParams ( array $required )

protected

Checks required parameters in $_GET. Fills error collection if required parameter is missed.

Аргументы

array $required Required parameters.

Возвращает: bool

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

◆ checkRequiredInputParams()

checkRequiredInputParams	(	array	$inputParams,
		array	$required )

protected

Checks required parameters. Fills error collection if required parameter is missed.

Аргументы

array	$inputParams	Input data.
array	$required	Required parameters.

Возвращает: bool

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

◆ checkRequiredModules()

checkRequiredModules ( )

protected

Checks required modules before process action.

Возвращает: void

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

◆ checkRequiredPostParams()

checkRequiredPostParams ( array $required )

protected

Checks required parameters in $_POST. Fills error collection if required parameter is missed.

Аргументы

array $required Required parameters.

Возвращает: bool

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

◆ end()

end ( )

protected

Terminates controller and application. This method replaces "die()" or "exit()" and ensures life cycle of application.

Возвращает: void

@noinspection PhpUndefinedClassInspection

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

◆ exec()

exec ( )

Executes controller by specific action. This method contains all steps of life cycle controller.

Возвращает: void

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

◆ getAction()

getAction ( )

Gets current action.

Возвращает: string

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

◆ getActionDescription()

getActionDescription ( )

Gets description of action.

Возвращает: array

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

◆ getApplication()

getApplication ( )

protected

Get application instance.

Возвращает: Application|\Bitrix\Main\HttpApplication|\CAllMain|\CMain

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

◆ getErrorByCode()

getErrorByCode ( $code )

Getting once error with the necessary code.

Аргументы

string $code Code of error.

Возвращает: Error[]

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

◆ getErrors()

getErrors ( )

Getting array of errors.

Возвращает: Error[]

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

◆ getUser()

getUser ( )

protected

Gets current user.

Возвращает: array|bool|\CAllUser|\CUser

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

◆ init()

init ( )

protected

Initializes controller. This method is invoked at the end of constructor.

Возвращает: void

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

◆ isAjaxRequest()

isAjaxRequest ( )

protected

Returns whether this is an AJAX (XMLHttpRequest) request.

Возвращает: boolean

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

◆ listActions()

listActions ( )

protected

Lists all actions by controller. This listing may contains description in short-style.

If you set array( 'showTest' )

Then action 'showTest' has default description

См. также: normalizeActionDescription() and execute method processActionShowTest.

If you set array( 'showFoo' => 'showBar' )

Then action 'showFoo' has default description

См. также: normalizeActionDescription() and execute method processActionShowBar.

If you set array( 'showFoo' => array( 'method' => array('GET', 'POST'), //allowed GET and POST methods to run action. 'name' => 'showFoo', //execute method processActionShowFoo 'check_csrf_token' => true, // check csrf token and run

См. также: runProcessingIfInvalidCsrfToken() 'redirect_on_auth' => true, // if user doesn't authorize then will redirect on login page. 'close_session' => false, //execute session_close() before action. ) )

Возвращает: array

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

◆ normalizeActionDescription()

normalizeActionDescription	(		$action,
			$description )

protected

Normalizes action description.

Default description: array( 'method' => array('GET'), //allowed methods to run action. 'name' => $action, //action which will run 'check_csrf_token' => false, // check csrf token 'redirect_on_auth' => true, // if user doesn't authorize then will redirect on login page. 'close_session' => false, //execute session_close() before action. )

Аргументы

string	$action	Action name.
array \| string	$description	Action description.

Возвращает: array

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

◆ normalizeListOfAction()

normalizeListOfAction ( array $listOfActions )

protected

Normalizes list of action to general view.

Аргументы

array $listOfActions List of action (

См. также: listActions()).

Возвращает: array

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

◆ prepareParams()

prepareParams ( )

protected

Prepare params before process action.

Возвращает: bool

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

◆ processBeforeAction()

processBeforeAction ( $actionName )

protected

Common operations before process action.

Аргументы

string $actionName Action name which will be run.

Возвращает: bool If method will return false, then action will not execute.

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

◆ resolveAction()

resolveAction ( )

protected

Resolves action and description of action, which need to run.

См. также: listActions().

Возвращает: $this

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

◆ runAction()

runAction ( )

protected

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

◆ runProcessingException()

runProcessingException ( \Exception $e )

protected

Runs processing exception.

Аргументы

\Exception $e Exception.

Возвращает: void

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

◆ runProcessingIfInvalidCsrfToken()

runProcessingIfInvalidCsrfToken ( )

protected

Runs processing if csrf token is invalid.

Возвращает: void

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

◆ runProcessingIfUserNotAuthorized()

runProcessingIfUserNotAuthorized ( )

protected

Runs processing if user is not authorized.

Возвращает: void

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

◆ sendJsonAccessDeniedResponse()

sendJsonAccessDeniedResponse ( $message = '' )

protected

Sends JSON response with status "denied" and terminates controller.

Аргументы

string $message Message.

Возвращает: void

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

◆ sendJsonInvalidSignResponse()

sendJsonInvalidSignResponse ( $message = '' )

protected

Sends JSON response with status "invalid_sign" and terminates controller.

Аргументы

string $message Message.

Возвращает: void

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

◆ sendJsonResponse()

sendJsonResponse	(		$response,
			$params = null )

protected

Sends JSON response and terminates controller.

Аргументы

mixed	$response
null \| array	$params

Возвращает: void

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

◆ sendJsonSuccessResponse()

sendJsonSuccessResponse ( array $response = array() )

protected

Sends JSON response with status "success" and mixed data, and terminates controller.

Аргументы

array $response Data to response.

Возвращает: void

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

◆ sendResponse()

sendResponse ( $response )

protected

Sends response and terminates controller. Automatically restart buffer.

Аргументы

mixed $response Mixed data to response.

Возвращает: void

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

◆ setAction()

setAction	(		$action,
		array	$description )

Sets action and description.

Аргументы

string	$action	Action name.
array	$description	Action description.

Возвращает: $this

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

◆ setActionName()

setActionName ( $action )

Sets action name.

Аргументы

string $action Action name.

Возвращает: $this

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

◆ triggerOnBeforeAction()

triggerOnBeforeAction ( $action )

protected

Triggers the event {{static::EVENT_ON_BEFORE_ACTION . $action}}. This method is invoked right before an action is executed. In case the action should not run, event handler have to return EvenResult with type EventResult::ERROR.

Аргументы

string $action Action name.

Возвращает: bool

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

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

◆ $action

$action

protected

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

◆ $actionDescription

$actionDescription

protected

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

◆ $errorCollection

$errorCollection

protected

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

◆ $realActionName

$realActionName

protected

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

◆ $request

$request

protected

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

◆ ERROR_REQUIRED_PARAMETER

const ERROR_REQUIRED_PARAMETER = 'REPORT_CONTROLLER_22001'

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

◆ ERROR_UNKNOWN_ACTION

const ERROR_UNKNOWN_ACTION = 'REPORT_CONTROLLER_22002'

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

◆ EVENT_ON_BEFORE_ACTION

const EVENT_ON_BEFORE_ACTION = 'onBeforeAction'

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

◆ STATUS_DENIED

const STATUS_DENIED = 'denied'

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

◆ STATUS_ERROR

const STATUS_ERROR = 'error'

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

◆ STATUS_INVALID_SIGN

const STATUS_INVALID_SIGN = 'invalid_sign'

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

◆ STATUS_NEED_AUTH

const STATUS_NEED_AUTH = 'need_auth'

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

◆ STATUS_RESTRICTION

const STATUS_RESTRICTION = 'restriction'

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

◆ STATUS_SUCCESS

const STATUS_SUCCESS = 'success'

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

Bitrix-D7 23.9

Открытые члены

Открытые атрибуты

Защищенные члены

Защищенные данные

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

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

◆ __construct()

Методы

◆ checkAction()

◆ checkRequiredFilesParams()

◆ checkRequiredGetParams()

◆ checkRequiredInputParams()

◆ checkRequiredModules()

◆ checkRequiredPostParams()

◆ end()

◆ exec()

◆ getAction()

◆ getActionDescription()

◆ getApplication()

◆ getErrorByCode()

◆ getErrors()

◆ getUser()

◆ init()

◆ isAjaxRequest()

◆ listActions()

◆ normalizeActionDescription()

◆ normalizeListOfAction()

◆ prepareParams()

◆ processBeforeAction()

◆ resolveAction()

◆ runAction()

◆ runProcessingException()

◆ runProcessingIfInvalidCsrfToken()

◆ runProcessingIfUserNotAuthorized()

◆ sendJsonAccessDeniedResponse()

◆ sendJsonInvalidSignResponse()

◆ sendJsonResponse()

◆ sendJsonSuccessResponse()

◆ sendResponse()

◆ setAction()

◆ setActionName()

◆ triggerOnBeforeAction()

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

◆ $action

◆ $actionDescription

◆ $errorCollection

◆ $realActionName

◆ $request

◆ ERROR_REQUIRED_PARAMETER

◆ ERROR_UNKNOWN_ACTION

◆ EVENT_ON_BEFORE_ACTION

◆ STATUS_DENIED

◆ STATUS_ERROR

◆ STATUS_INVALID_SIGN

◆ STATUS_NEED_AUTH

◆ STATUS_RESTRICTION

◆ STATUS_SUCCESS