@file Class that holds information relating to a layouts context.

Hierarchy

Expanded class hierarchy of LayoutContext

File

core/modules/layout/plugins/context/layout_context.inc, line 6
Class that holds information relating to a layouts context.

Members

Contains filters are case sensitive
Name Modifierssort ascending Type Description
LayoutContext::type abstract function Return the indicator for this context, i.e. "entity", "string".
LayoutContext::__construct function Constructor for LayoutContext objects. Overrides LayoutHandler::__construct
LayoutContext::label function Assemble a human-readable label of this object. Overrides LayoutHandler::label
LayoutContext::setData function Set the data for this context.
LayoutContext::isA function Check if this context matches a plugin name.
LayoutContext::form function Settings form for configuring this context item.
LayoutContext::formValidate function Validate handler for the settings form for this context item.
LayoutContext::formSubmit function Submit handler for the settings form for this context item.
LayoutContext::getAdminSummary function Return a summary for this context.
LayoutContext::setDataFromRouterMap function Set the context data from the router item map.
LayoutHandler::toArray function Convert this object's properties to an array.
LayoutContext::USAGE_TYPE_CUSTOM constant Declares a LayoutContext to be a manually specified custom context.
LayoutContext::USAGE_TYPE_MENU constant Declares a LayoutContext to be provided based on a menu item or path.
LayoutContext::USAGE_TYPE_SYSTEM constant Declares a LayoutContext to be a system-wide context
LayoutContext::USAGE_TYPE_RELATIONSHIP constant Declares a LayoutContext is provided by a relationship to another context.
LayoutContext::USAGE_TYPE_ALL constant All possible context types.