Класс Widget

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

Открытые члены
	configureActions ()
	showConfigurationFormAction ($widgetId, $boardId)
	saveConfigurationFormAction ($formParams)
	addWidgetFromConfigurationFormAction ($formParams)
	buildFormAction ($params)
	checkIsCompatibleWithSelectedViewAction ($params)
	constructPseudoWidgetAction ($params)
	loadAction ($widgetId)
	loadByBoardIdAction ($boardId)
	updateAction ($boardKey, $widgetId, $params)
	removeAction ($params)
	removePatternAction ($widgetId)
Открытые члены унаследованные от 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 ()
	getAutoWiredParameters ()
	getPrimaryAutoWiredParameter ()
	getDefaultAutoWiredParameters ()
	getRequest ()
	getScope ()
	setScope ($scope)
	getSourceParametersList ()
	setSourceParametersList ($sourceParametersList)
	run ($actionName, array $sourceParametersList)
	finalizeResponse (Response $response)
	generateActionMethodName ($action)
	redirectTo ($url)
	getErrors ()
	getErrorByCode ($code)

Дополнительные унаследованные члены
Открытые статические члены унаследованные от Controller
static	className ()
static	getFullEventName ($eventName)
Открытые атрибуты унаследованные от Controller
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'
Защищенные члены унаследованные от Base
	runProcessingException (\Exception $e)
Защищенные члены унаследованные от Controller
	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)
	runProcessingError (\Error $error)
	runProcessingBinderThrowable (BinderArgumentException $e)
	buildErrorFromException (\Exception $e)
	buildErrorFromPhpError (\Error $error)
	runProcessingIfUserNotAuthorized ()
	runProcessingIfInvalidCsrfToken ()
	addError (Error $error)
	addErrors (array $errors)
Защищенные данные унаследованные от Controller
	$errorCollection
	$request
Configurator	$configurator

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

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

Методы

addWidgetFromConfigurationFormAction()

addWidgetFromConfigurationFormAction

(

$formParams

)

Create widget from form params action and save it;

Аргументы

array

$formParams

Parameters from form.

Возвращает

array [widgetId => 'Gid of new created widget'].

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

buildFormAction()

buildFormAction

(

$params

)

Build create or configuration form.

Аргументы

array

$params

Parameters to create form.

Возвращает

Component|bool

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

checkIsCompatibleWithSelectedViewAction()

checkIsCompatibleWithSelectedViewAction

(

$params

)

This action call when try to change to other view type of existing widget. If new view key do not compatible with core view type return false, else true.

Аргументы

array

$params

Parameters like [newViewKey => 'linearGraph', oldViewKey => 'column'].

Возвращает

array|bool

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

configureActions()

configureActions

(

)

Возвращает

array

Переопределяет метод предка Controller.

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

constructPseudoWidgetAction()

constructPseudoWidgetAction

(

$params

)

Construct widget for show preview.

Аргументы

array

$params

Form params will be apply in preview widget.

Возвращает

array|bool

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

loadAction()

loadAction

(

$widgetId

)

Load widget params for rendering.

Аргументы

string

$widgetId

Widget gId.

Возвращает

array|false

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

loadByBoardIdAction()

loadByBoardIdAction

(

$boardId

)

Load widget by board Id.

Аргументы

string

$boardId

Board id.

Возвращает

array

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

removeAction()

removeAction

(

$params

)

Remove widget from board action.

Аргументы

array

$params

Parameters like [boardId => 'some_board_id', widgetId => 'some_widget_gId'].

Возвращает

bool

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

removePatternAction()

removePatternAction

(

$widgetId

)

Remove pattern widget. Delete only current user pattern widget.

Аргументы

string

$widgetId

Widget id.

Возвращает

void

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

saveConfigurationFormAction()

saveConfigurationFormAction

(

$formParams

)

Configuration form save handler.

Аргументы

array

$formParams

Parameters form form to save widget configurations.

Возвращает

array|bool

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

showConfigurationFormAction()

showConfigurationFormAction	(		$widgetId,
			$boardId )

Action return configuration form by widget gid, and board gid.

Аргументы

string	$widgetId	Widget gId.
string	$boardId	Board key.

Возвращает

Component|bool

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

updateAction()

updateAction	(		$boardKey,
			$widgetId,
			$params )

Widget update action. Call whan save configuration form.

Аргументы

string	$boardKey	Board key.
string	$widgetId	Widget gId.
array	$params	Form parameters to apply in update of widget.

Возвращает

string Saved widget gId.

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