class AjaxWidgetContextHolder (View source)

This object stores the WidgetContext for the currently active widgets of the current user, to make sure the WidgetContext is available in Widget AJAX requests.

This class is only used internally by the widget framework.

Properties

protected array $widgetContexts

An array $ajaxWidgetIdentifier => $widgetContext which stores the widget context.

Methods

get(string $ajaxWidgetId)

Get the widget context for the given $ajaxWidgetId.

void
store(WidgetContext $widgetContext)

Stores the WidgetContext inside the Context, and sets the AjaxWidgetIdentifier inside the Widget Context correctly.

Details

WidgetContext get(string $ajaxWidgetId)

Get the widget context for the given $ajaxWidgetId.

Parameters

string $ajaxWidgetId

Return Value

WidgetContext

Exceptions

WidgetContextNotFoundException

void store(WidgetContext $widgetContext)

Stores the WidgetContext inside the Context, and sets the AjaxWidgetIdentifier inside the Widget Context correctly.

Parameters

WidgetContext $widgetContext

Return Value

void