interface LayoutInterface in Drupal 9

Provides an interface for static Layout plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Component\Plugin\DerivativeInspectionInterface; interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Core\Plugin\ContextAwarePluginInterface
  • interface \Drupal\Core\Layout\LayoutInterface

6 files declare their use of LayoutInterface

ConfigureSectionForm.php in core/modules/layout_builder/src/Form/ConfigureSectionForm.php

EntityDisplayWithLayoutInterface.php in core/modules/field_layout/src/Display/EntityDisplayWithLayoutInterface.php

FieldLayoutEntityDisplayTrait.php in core/modules/field_layout/src/Entity/FieldLayoutEntityDisplayTrait.php

SectionComponentTest.php in core/modules/layout_builder/tests/src/Unit/SectionComponentTest.php

SectionRenderTest.php in core/modules/layout_builder/tests/src/Unit/SectionRenderTest.php

... See full list

File

core/lib/Drupal/Core/Layout/LayoutInterface.php, line 14

Namespace

Drupal\Core\Layout

interface LayoutInterface extends PluginInspectionInterface, DerivativeInspectionInterface, ConfigurableInterface, DependentPluginInterface, ContextAwarePluginInterface {

  /**
   * Build a render array for layout with regions.
   *
   * @param array $regions
   *   An associative array keyed by region name, containing render arrays
   *   representing the content that should be placed in each region.
   *
   * @return array
   *   Render array for the layout with regions.
   */
  public function build(array $regions);

  /**
   * {@inheritdoc}
   *
   * @return \Drupal\Core\Layout\LayoutDefinition
   */
  public function getPluginDefinition();

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	14
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	15
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	15
ContextAwarePluginInterface::getContext	public	function	Gets a defined context.	1
ContextAwarePluginInterface::getContextDefinition	public	function	Gets a specific context definition of the plugin. Overrides ContextAwarePluginInterface::getContextDefinition
ContextAwarePluginInterface::getContextDefinitions	public	function	Gets the context definitions of the plugin. Overrides ContextAwarePluginInterface::getContextDefinitions
ContextAwarePluginInterface::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names.
ContextAwarePluginInterface::getContexts	public	function	Gets the defined contexts.	1
ContextAwarePluginInterface::getContextValue	public	function	Gets the value for a defined context.	1
ContextAwarePluginInterface::getContextValues	public	function	Gets the values for all defined contexts.	1
ContextAwarePluginInterface::setContext	public	function	Set a context on this plugin.	2
ContextAwarePluginInterface::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names.
ContextAwarePluginInterface::setContextValue	public	function	Sets the value for a defined context.	1
ContextAwarePluginInterface::validateContexts	public	function	Validates the set values for the defined contexts.	1
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	20
DerivativeInspectionInterface::getBaseId	public	function	Gets the base_plugin_id of the plugin instance.	1
DerivativeInspectionInterface::getDerivativeId	public	function	Gets the derivative_id of the plugin instance.	1
LayoutInterface::build	public	function	Build a render array for layout with regions.	1
LayoutInterface::getPluginDefinition	public	function	Overrides PluginInspectionInterface::getPluginDefinition
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2