interface LayoutInterface

Provides an interface for static Layout plugins.

Hierarchy

Expanded class hierarchy of LayoutInterface

All classes that implement LayoutInterface

5 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

File

View on git.drupalcode.org

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

Namespace

Drupal\Core\Layout
View source 
interface LayoutInterface extends PluginInspectionInterface, DerivativeInspectionInterface, ConfigurableInterface, DependentPluginInterface, ConfigurablePluginInterface {
  
  /**
   * 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

Title Modifiers Object type Summary Overriden Title Overrides
ConfigurableInterface::defaultConfiguration public function Gets default configuration for this plugin. 13
ConfigurableInterface::getConfiguration public function Gets this plugin's configuration. 14
ConfigurableInterface::setConfiguration public function Sets the configuration for this plugin instance. 14
DependentPluginInterface::calculateDependencies public function Calculates dependencies for the configured plugin. 21
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.