1. interface
  2. Drupal
  3. \
  4. Component
  5. \
  6. Plugin
  7. \
  8. ContextAwarePluginInterface

ContextAwarePluginInterface

interface ContextAwarePluginInterface implements PluginInspectionInterface (View source)

Interface for defining context aware plugins.

Context aware plugins can specify an array of context definitions keyed by context name at the plugin definition under the "context" key.

Methods

string
getPluginId()

Gets the plugin_id of the plugin instance.

from  PluginInspectionInterface
array
getPluginDefinition()

Gets the definition of the plugin implementation.

from  PluginInspectionInterface
ContextDefinitionInterface[]
getContextDefinitions()

Gets the context definitions of the plugin.

ContextDefinitionInterface
getContextDefinition(string $name)

Gets a specific context definition of the plugin.

array
getContexts()

Gets the defined contexts.

ContextInterface
getContext(string $name)

Gets a defined context.

array
getContextValues()

Gets the values for all defined contexts.

mixed
getContextValue(string $name)

Gets the value for a defined context.

setContext(string $name, ContextInterface $context)

Set a context on this plugin.

$this
setContextValue(string $name, mixed $value)

Sets the value for a defined context.

ConstraintViolationListInterface
validateContexts()

Validates the set values for the defined contexts.

array
getContextMapping()

Gets a mapping of the expected assignment names to their context names.

$this
setContextMapping(array $context_mapping)

Sets a mapping of the expected assignment names to their context names.

Details

in PluginInspectionInterface at line 21
string getPluginId()

Gets the plugin_id of the plugin instance.

Return Value

string

The plugin_id of the plugin instance.

in PluginInspectionInterface at line 30
array getPluginDefinition()

Gets the definition of the plugin implementation.

Return Value

array

The plugin definition, as returned by the discovery object used by the plugin manager.

at line 23
ContextDefinitionInterface[] getContextDefinitions()

Gets the context definitions of the plugin.

Return Value

ContextDefinitionInterface[]

The array of context definitions, keyed by context name.

at line 37
ContextDefinitionInterface getContextDefinition(string $name)

Gets a specific context definition of the plugin.

Parameters

string $name

The name of the context in the plugin definition.

Return Value

ContextDefinitionInterface

The definition against which the context value must validate.

Exceptions

PluginException

at line 48
array getContexts()

Gets the defined contexts.

Return Value

array

The set context objects.

Exceptions

PluginException

at line 62
ContextInterface getContext(string $name)

Gets a defined context.

Parameters

string $name

The name of the context in the plugin definition.

Return Value

ContextInterface

The context object.

Exceptions

PluginException

at line 71
array getContextValues()

Gets the values for all defined contexts.

Return Value

array

An array of set context values, keyed by context name. If a context is unset its value is returned as NULL.

at line 85
mixed getContextValue(string $name)

Gets the value for a defined context.

Parameters

string $name

The name of the context in the plugin configuration.

Return Value

mixed

The currently set context value.

Exceptions

PluginException

at line 95
setContext(string $name, ContextInterface $context)

Set a context on this plugin.

Parameters

string $name

The name of the context in the plugin configuration.
ContextInterface $context

The context object to set.

at line 112
$this setContextValue(string $name, mixed $value)

Sets the value for a defined context.

Parameters

string $name

The name of the context in the plugin definition.
mixed $value

The value to set the context to. The value has to validate against the provided context definition.

Return Value

$this

A context aware plugin object for chaining.

Exceptions

PluginException

at line 121
ConstraintViolationListInterface validateContexts()

Validates the set values for the defined contexts.

Return Value

ConstraintViolationListInterface

A list of constraint violations. If the list is empty, validation succeeded.

at line 132
array getContextMapping()

Gets a mapping of the expected assignment names to their context names.

Return Value

array

A mapping of the expected assignment names to their context names. For example, if one of the $contexts is named 'user.current_user', but the plugin expects a context named 'user', then this map would contain 'user' => 'user.current_user'.

at line 145
$this setContextMapping(array $context_mapping)

Sets a mapping of the expected assignment names to their context names.

Parameters

array $context_mapping

A mapping of the expected assignment names to their context names. For example, if one of the $contexts is named 'user.current_user', but the plugin expects a context named 'user', then this map would contain 'user' => 'user.current_user'.

Return Value

$this