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

Открытые члены
	__construct (Request $request=null)

	forward ($controller, string $actionName, array $parameters=null)

	getConfigurationOfActions ()

	getModuleId ()

	isLocatedUnderPsr4 ()

	getActionUri (string $actionName, array $params=[], bool $absolute=false)

	getUnsignedParameters ()

	getCurrentUser ()

	setCurrentUser (CurrentUser $currentUser)

	convertKeysToCamelCase ($data)

	listNameActions ()

	configureActions ()

	getAutoWiredParameters ()

	getPrimaryAutoWiredParameter ()

	getDefaultAutoWiredParameters ()

	getRequest ()

	getScope ()

	setScope ($scope)

	getSourceParametersList ()

	setSourceParametersList ($sourceParametersList)

	run ($actionName, array $sourceParametersList)

	finalizeResponse (Response $response)

	generateActionMethodName ($action)

	redirectTo ($url)

	getErrors ()

	getErrorByCode ($code)

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

static	getFullEventName ($eventName)

Открытые атрибуты
const	SCOPE_REST = 'rest'

const	SCOPE_AJAX = 'ajax'

const	SCOPE_CLI = 'cli'

const	EVENT_ON_BEFORE_ACTION = 'onBeforeAction'

const	EVENT_ON_AFTER_ACTION = 'onAfterAction'

const	ERROR_REQUIRED_PARAMETER = 'MAIN_CONTROLLER_22001'

const	ERROR_UNKNOWN_ACTION = 'MAIN_CONTROLLER_22002'

const	EXCEPTION_UNKNOWN_ACTION = 22002

Открытые атрибуты унаследованные от Controllerable
const	METHOD_ACTION_SUFFIX = 'Action'

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

	getFilePath ()

	processUnsignedParameters ()

	getSaltToUnsign ()

	writeToLogException (\Throwable $e)

	collectDebugInfo ()

	logDebugInfo ()

	prepareParams ()

	processBeforeAction (Action $action)

	shouldDecodePostData (Action $action)

	decodePostData ()

	triggerOnBeforeAction (Action $action)

	processAfterAction (Action $action, $result)

	triggerOnAfterAction (Action $action, $result)

	create ($actionName)

	buildActionInstance ($actionName, array $config)

	existsAction ($actionName)

	getDefaultPreFilters ()

	getDefaultPostFilters ()

	buildFilters (array $config=null)

	appendFilters (array $filters, array $filtersToAppend)

	removeFilters (array $filters, array $filtersToRemove)

	detachFilters (Action $action)

	detachPreFilters (Action $action)

	detachPostFilters (Action $action)

	getActionConfig ($actionName)

	setActionConfig ($actionName, array $config=null)

	runProcessingThrowable (\Throwable $throwable)

	runProcessingException (\Exception $e)

	runProcessingError (\Error $error)

	runProcessingBinderThrowable (BinderArgumentException $e)

	buildErrorFromException (\Exception $e)

	buildErrorFromPhpError (\Error $error)

	runProcessingIfUserNotAuthorized ()

	runProcessingIfInvalidCsrfToken ()

	addError (Error $error)

	addErrors (array $errors)

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

	$request

Configurator	$configurator

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

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

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

◆ __construct()

__construct ( Request $request = null )

Constructor Controller.

Аргументы

Request | null $request

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

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

Методы

◆ addError()

addError ( Error $error )

protected

Adds error to error collection.

Аргументы

Error $error Error.

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

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

◆ addErrors()

addErrors ( array $errors )

protected

Adds list of errors to error collection.

Аргументы

Error[] $errors Errors.

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

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

◆ appendFilters()

appendFilters	(	array	$filters,
		array	$filtersToAppend )

finalprotected

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

◆ buildActionInstance()

buildActionInstance	(		$actionName,
		array	$config )

finalprotected

См. также: Action::__construct

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

◆ buildErrorFromException()

buildErrorFromException ( \Exception $e )

protected

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

◆ buildErrorFromPhpError()

buildErrorFromPhpError ( \Error $error )

protected

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

◆ buildFilters()

buildFilters ( array $config = null )

finalprotected

Builds filter by config. If there is no config, then we use default filters

См. также: \Bitrix\Main\Engine\Controller::getDefaultPreFilters() and; \Bitrix\Main\Engine\Controller::getDefaultPostFilters(). If now is POST query and there is no csrf check in config, then we add it.

Аргументы

array | null $config

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

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

◆ className()

static className ( )

staticfinal

Returns the fully qualified name of this class.

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

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

◆ collectDebugInfo()

collectDebugInfo ( )

finalprotected

Collects debug info by Diag.

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

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

◆ configureActions()

configureActions ( )

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

Замещает Controllerable.

Переопределяется в CalendarAjax, CalendarEntryAjax, ResourceBookingAjax, SharingAjax, SyncAjax, ProductSelector, SkuTree, HtmlEditorAjax, Call, Disk, Chat, Message, Secretary, Agreement, AuthCode, Export, LoadExt, PhoneAuth, PhoneNumber, QrCodeAuth, Rating, ComponentController, DefaultController, Token, Widget, Entity, FacebookConversion, Entity, Robokassa, AuthFlow, Grabber, File, Csv, Csv, Collector и FileUploader.

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

◆ 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

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

◆ create()

create ( $actionName )

protected

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

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

◆ decodePostData()

decodePostData ( )

finalprotected

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

◆ detachFilters()

detachFilters ( Action $action )

finalprotected

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

◆ detachPostFilters()

detachPostFilters ( Action $action )

finalprotected

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

◆ detachPreFilters()

detachPreFilters ( Action $action )

finalprotected

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

◆ existsAction()

existsAction ( $actionName )

finalprotected

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

◆ finalizeResponse()

finalizeResponse ( Response $response )

Finalizes response. The method will be invoked when HttpApplication will be ready to send response to client. It's a final place where Controller can interact with response.

Аргументы

Response $response

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

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

◆ forward()

forward	(		$controller,
		string	$actionName,
		array	$parameters = null )

Аргументы

Controller \| string	$controller
string	$actionName
array \| null	$parameters

Возвращает: HttpResponse|mixed

Исключения

SystemException

См. также: \Bitrix\Main\Engine\ControllerBuilder::build

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

◆ generateActionMethodName()

generateActionMethodName ( $action )

final

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

◆ getActionConfig()

getActionConfig ( $actionName )

finalprotected

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

◆ getActionUri()

getActionUri	(	string	$actionName,
		array	$params = [],
		bool	$absolute = false )

final

Returns uri for ajax end point for the action name. It's a helper, which uses relative action name without controller name.

Аргументы

string	$actionName	Action name. It's a relative action name without controller name.
array	$params	Parameters for creating uri.
bool	$absolute

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

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

◆ getAutoWiredParameters()

getAutoWiredParameters ( )

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

Переопределяется в BaseController, Message, Basket, Composition, Switcher и FileUploader.

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

◆ getConfigurationOfActions()

getConfigurationOfActions ( )

final

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

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

◆ getCurrentUser()

getCurrentUser ( )

final

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

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

◆ getDefaultAutoWiredParameters()

getDefaultAutoWiredParameters ( )

final

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

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

◆ getDefaultPostFilters()

getDefaultPostFilters ( )

protected

Returns default post-filters for action.

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

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

◆ getDefaultPreFilters()

getDefaultPreFilters ( )

protected

Returns default pre-filters for action.

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

Переопределяется в Mode, ProductForm, ProductSelector, SkuTree, StoreSelector, DefaultElement, Element, Disk, BaseController, Import, Message, General, Notify, Status, Cookies, DiskFile, Landing, Note, User, Address, Format, Location, Source, Toolbar, UserFieldConfig, UserOption, JsonController, BaseReceiver, Application, Configuration, Import, File, ConsentPreview, Base, EntitySelector, Feedback и FileUploader.

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

◆ getErrorByCode()

getErrorByCode ( $code )

final

Getting once error with the necessary code.

Аргументы

string $code Code of error.

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

Замещает Errorable.

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

◆ getErrors()

getErrors ( )

final

Getting array of errors.

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

Замещает Errorable.

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

◆ getFilePath()

getFilePath ( )

finalprotected

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

◆ getFullEventName()

static getFullEventName ( $eventName )

staticfinal

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

◆ getModuleId()

getModuleId ( )

final

Returns module id. Tries to guess module id by file path and function

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

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

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

◆ getPrimaryAutoWiredParameter()

getPrimaryAutoWiredParameter ( )

Возвращает: Parameter|null

Переопределяется в Chat, Message, User и Basket.

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

◆ getRequest()

getRequest ( )

final

Возвращает: \Bitrix\Main\HttpRequest

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

◆ getSaltToUnsign()

getSaltToUnsign ( )

protected

Tries to find salt from request. It's "c" (component name) in general.

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

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

◆ getScope()

getScope ( )

final

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

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

◆ getSourceParametersList()

getSourceParametersList ( )

final

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

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

◆ getUnsignedParameters()

getUnsignedParameters ( )

final

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

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

◆ init()

init ( )

protected

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

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

Переопределяется в Base, ProductSelector, StoreSelector, Address, Format, Source, Base, Export, Base, Composition, Switcher, Grabber, Csv, Csv и Controller.

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

◆ isLocatedUnderPsr4()

isLocatedUnderPsr4 ( )

final

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

◆ listNameActions()

listNameActions ( )

final

Returns list of all

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

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

◆ logDebugInfo()

logDebugInfo ( )

finalprotected

Logs debug info by Diag.

Исключения

Bitrix\Main\SystemException

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

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

◆ prepareParams()

prepareParams ( )

protected

Prepare params before process action.

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

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

◆ processAfterAction()

processAfterAction	(	Action	$action,
			$result )

protected

Common operations after process action. If the method returns void or null it means that we don't want to modify $result.

Аргументы

Action	$action
	$result

Возвращает: HttpResponse|mixed|void

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

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

◆ processBeforeAction()

processBeforeAction ( Action $action )

protected

Common operations before process action.

Аргументы

Action $action

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

Переопределяется в Config, ProductSelector, StoreSelector, Beta, Disk, Conference, JitsiLite, Application, Secretary, Xscan и FileUploader.

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

◆ processUnsignedParameters()

processUnsignedParameters ( )

finalprotected

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

◆ redirectTo()

redirectTo ( $url )

Redirect to URL.

Аргументы

string $url

Возвращает: \Bitrix\Main\Engine\Response\Redirect

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

◆ removeFilters()

removeFilters	(	array	$filters,
		array	$filtersToRemove )

finalprotected

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

◆ run()

run	(		$actionName,
		array	$sourceParametersList )

final

Аргументы

	$actionName
array	$sourceParametersList

Возвращает: HttpResponse|mixed

Исключения

SystemException

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

◆ runProcessingBinderThrowable()

runProcessingBinderThrowable ( BinderArgumentException $e )

protected

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

◆ runProcessingError()

runProcessingError ( \Error $error )

protected

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

◆ runProcessingException()

runProcessingException ( \Exception $e )

protected

Runs processing exception.

Аргументы

\Exception $e Exception.

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

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

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

◆ runProcessingIfInvalidCsrfToken()

runProcessingIfInvalidCsrfToken ( )

protected

Runs processing if csrf token is invalid.

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

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

◆ runProcessingIfUserNotAuthorized()

runProcessingIfUserNotAuthorized ( )

protected

Runs processing if user is not authorized.

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

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

◆ runProcessingThrowable()

runProcessingThrowable ( \Throwable $throwable )

protected

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

◆ setActionConfig()

setActionConfig	(		$actionName,
		array	$config = null )

finalprotected

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

◆ setCurrentUser()

setCurrentUser ( CurrentUser $currentUser )

final

Аргументы

CurrentUser $currentUser

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

◆ setScope()

setScope ( $scope )

final

Аргументы

string $scope

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

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

◆ setSourceParametersList()

setSourceParametersList ( $sourceParametersList )

final

Аргументы

array $sourceParametersList

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

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

◆ shouldDecodePostData()

shouldDecodePostData ( Action $action )

protected

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

◆ triggerOnAfterAction()

triggerOnAfterAction	(	Action	$action,
			$result )

finalprotected

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

◆ triggerOnBeforeAction()

triggerOnBeforeAction ( Action $action )

finalprotected

Triggers the event {{static::EVENT_ON_BEFORE_ACTION}}

См. также: \Bitrix\Main\Engine\Controller::getFullEventName. 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.

Аргументы

Action $action Action name.

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

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

◆ writeToLogException()

writeToLogException ( \Throwable $e )

protected

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

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

◆ $configurator

Configurator $configurator

protected

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

◆ $errorCollection

$errorCollection

protected

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

◆ $request

$request

protected

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

◆ ERROR_REQUIRED_PARAMETER

const ERROR_REQUIRED_PARAMETER = 'MAIN_CONTROLLER_22001'

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

◆ ERROR_UNKNOWN_ACTION

const ERROR_UNKNOWN_ACTION = 'MAIN_CONTROLLER_22002'

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

◆ EVENT_ON_AFTER_ACTION

const EVENT_ON_AFTER_ACTION = 'onAfterAction'

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

◆ EVENT_ON_BEFORE_ACTION

const EVENT_ON_BEFORE_ACTION = 'onBeforeAction'

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

◆ EXCEPTION_UNKNOWN_ACTION

const EXCEPTION_UNKNOWN_ACTION = 22002

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

◆ SCOPE_AJAX

const SCOPE_AJAX = 'ajax'

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

◆ SCOPE_CLI

const SCOPE_CLI = 'cli'

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

◆ SCOPE_REST

const SCOPE_REST = 'rest'

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

Bitrix-D7 23.9

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

Открытые статические члены

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

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

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

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

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

◆ __construct()

Методы

◆ addError()

◆ addErrors()

◆ appendFilters()

◆ buildActionInstance()

◆ buildErrorFromException()

◆ buildErrorFromPhpError()

◆ buildFilters()

◆ className()

◆ collectDebugInfo()

◆ configureActions()

◆ convertKeysToCamelCase()

◆ create()

◆ decodePostData()

◆ detachFilters()

◆ detachPostFilters()

◆ detachPreFilters()

◆ existsAction()

◆ finalizeResponse()

◆ forward()

◆ generateActionMethodName()

◆ getActionConfig()

◆ getActionUri()

◆ getAutoWiredParameters()

◆ getConfigurationOfActions()

◆ getCurrentUser()

◆ getDefaultAutoWiredParameters()

◆ getDefaultPostFilters()

◆ getDefaultPreFilters()

◆ getErrorByCode()

◆ getErrors()

◆ getFilePath()

◆ getFullEventName()

◆ getModuleId()

◆ getPrimaryAutoWiredParameter()

◆ getRequest()

◆ getSaltToUnsign()

◆ getScope()

◆ getSourceParametersList()

◆ getUnsignedParameters()

◆ init()

◆ isLocatedUnderPsr4()

◆ listNameActions()

◆ logDebugInfo()

◆ prepareParams()

◆ processAfterAction()

◆ processBeforeAction()

◆ processUnsignedParameters()

◆ redirectTo()

◆ removeFilters()

◆ run()

◆ runProcessingBinderThrowable()

◆ runProcessingError()

◆ runProcessingException()

◆ runProcessingIfInvalidCsrfToken()

◆ runProcessingIfUserNotAuthorized()

◆ runProcessingThrowable()

◆ setActionConfig()

◆ setCurrentUser()

◆ setScope()

◆ setSourceParametersList()

◆ shouldDecodePostData()

◆ triggerOnAfterAction()

◆ triggerOnBeforeAction()

◆ writeToLogException()

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

◆ $configurator

◆ $errorCollection

◆ $request

◆ ERROR_REQUIRED_PARAMETER

◆ ERROR_UNKNOWN_ACTION

◆ EVENT_ON_AFTER_ACTION