1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Layout
  7. \
  8. LayoutInterface

LayoutInterface

interface LayoutInterface implements PluginInspectionInterface, DerivativeInspectionInterface, ConfigurableInterface, DependentPluginInterface, ContextAwarePluginInterface (View source)

Provides an interface for static Layout plugins.

Methods

string
getPluginId()

Gets the plugin_id of the plugin instance.

from  PluginInspectionInterface
array
getPluginDefinition()

Gets the definition of the plugin implementation.

string
getBaseId()

Gets the base_plugin_id of the plugin instance.

from  DerivativeInspectionInterface
string|null
getDerivativeId()

Gets the derivative_id of the plugin instance.

from  DerivativeInspectionInterface
array
getConfiguration()

Gets this plugin's configuration.

from  ConfigurableInterface
setConfiguration(array $configuration)

Sets the configuration for this plugin instance.

from  ConfigurableInterface
array
defaultConfiguration()

Gets default configuration for this plugin.

from  ConfigurableInterface
array
calculateDependencies()

Calculates dependencies for the configured plugin.

from  DependentPluginInterface
ContextDefinitionInterface[]
getContextDefinitions()

Gets the context definitions of the plugin.

from  ContextAwarePluginInterface
ContextDefinitionInterface
getContextDefinition(string $name)

Gets a specific context definition of the plugin.

from  ContextAwarePluginInterface
array
getContexts()

Gets the defined contexts.

from  ContextAwarePluginInterface
ContextInterface
getContext(string $name)

Gets a defined context.

from  ContextAwarePluginInterface
array
getContextValues()

Gets the values for all defined contexts.

from  ContextAwarePluginInterface
mixed
getContextValue(string $name)

Gets the value for a defined context.

from  ContextAwarePluginInterface
setContext(string $name, ContextInterface $context)

Set a context on this plugin.

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

Sets the value for a defined context.

from  ContextAwarePluginInterface
ConstraintViolationListInterface
validateContexts()

Validates the set values for the defined contexts.

from  ContextAwarePluginInterface
array
getContextMapping()

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

from  ContextAwarePluginInterface
$this
setContextMapping(array $context_mapping)

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

from  ContextAwarePluginInterface
array
build(array $regions)

Build a render array for layout with regions.

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.

at line 33
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.

in DerivativeInspectionInterface at line 16
string getBaseId()

Gets the base_plugin_id of the plugin instance.

Return Value

string

The base_plugin_id of the plugin instance.

in DerivativeInspectionInterface at line 24
string|null getDerivativeId()

Gets the derivative_id of the plugin instance.

Return Value

string|null

The derivative_id of the plugin instance NULL otherwise.

in ConfigurableInterface at line 18
array getConfiguration()

Gets this plugin's configuration.

Return Value

array

An array of this plugin's configuration.

in ConfigurableInterface at line 26
setConfiguration(array $configuration)

Sets the configuration for this plugin instance.

Parameters

array $configuration

An associative array containing the plugin's configuration.

in ConfigurableInterface at line 34
array defaultConfiguration()

Gets default configuration for this plugin.

Return Value

array

An associative array with the default configuration.

in DependentPluginInterface at line 35
array calculateDependencies()

Calculates dependencies for the configured plugin.

Dependencies are saved in the plugin's configuration entity and are used to determine configuration synchronization order. For example, if the plugin integrates with specific user roles, this method should return an array of dependencies listing the specified roles.

Return Value

array

An array of dependencies grouped by type (config, content, module, theme). For example: @code array( 'config' => array('user.role.anonymous', 'user.role.authenticated'), 'content' => array('node:article:f0a189e6-55fb-47fb-8005-5bef81c44d6d'), 'module' => array('node', 'user'), 'theme' => array('seven'), ); @endcode

See also

ConfigDependencyManager
EntityInterface::getConfigDependencyName

in ContextAwarePluginInterface at line 23
ContextDefinitionInterface[] getContextDefinitions()

Gets the context definitions of the plugin.

Return Value

ContextDefinitionInterface[]

The array of context definitions, keyed by context name.

in ContextAwarePluginInterface 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

ContextException

in ContextAwarePluginInterface at line 48
array getContexts()

Gets the defined contexts.

Return Value

array

The set context objects.

Exceptions

ContextException

in ContextAwarePluginInterface 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

ContextException

in ContextAwarePluginInterface 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.

in ContextAwarePluginInterface 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

ContextException

in ContextAwarePluginInterface 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.

in ContextAwarePluginInterface 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

ContextException

in ContextAwarePluginInterface 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.

in ContextAwarePluginInterface 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'.

in ContextAwarePluginInterface 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

at line 26
array build(array $regions)

Build a render array for layout with regions.

Parameters

array $regions

An associative array keyed by region name, containing render arrays representing the content that should be placed in each region.

Return Value

array

Render array for the layout with regions.