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

LayoutInterface

interface LayoutInterface implements PluginInspectionInterface, DerivativeInspectionInterface, ConfigurableInterface, DependentPluginInterface, ConfigurablePluginInterface (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  ConfigurablePluginInterface
setConfiguration(array $configuration)

Sets the configuration for this plugin instance.

from  ConfigurablePluginInterface
array
defaultConfiguration()

Gets default configuration for this plugin.

from  ConfigurablePluginInterface
array
calculateDependencies()

Calculates dependencies for the configured plugin.

from  DependentPluginInterface
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 ConfigurablePluginInterface at line 27
array getConfiguration()

Gets this plugin's configuration.

Return Value

array

An array of this plugin's configuration.

in ConfigurablePluginInterface at line 35
setConfiguration(array $configuration)

Sets the configuration for this plugin instance.

Parameters

array $configuration

An associative array containing the plugin's configuration.

in ConfigurablePluginInterface at line 43
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

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.