interface LayoutInterface
Provides an interface for static Layout plugins.
Hierarchy
- interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Component\Plugin\DerivativeInspectionInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Plugin\ContextAwarePluginInterface extends \Drupal\Component\Plugin\ContextAwarePluginInterface- interface \Drupal\Core\Layout\LayoutInterface extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface, \Drupal\Component\Plugin\ConfigurableInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface
 
Expanded class hierarchy of LayoutInterface
All classes that implement LayoutInterface
7 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 
- LayoutPluginManagerTest.php in core/tests/ Drupal/ Tests/ Core/ Layout/ LayoutPluginManagerTest.php 
- SectionComponentTest.php in core/modules/ layout_builder/ tests/ src/ Unit/ SectionComponentTest.php 
1 string reference to 'LayoutInterface'
- layout_builder.schema.yml in core/modules/ layout_builder/ config/ schema/ layout_builder.schema.yml 
- core/modules/layout_builder/config/schema/layout_builder.schema.yml
File
- 
              core/lib/ Drupal/ Core/ Layout/ LayoutInterface.php, line 14 
Namespace
Drupal\Core\LayoutView source
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
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|
| ConfigurableInterface::defaultConfiguration | public | function | Gets default configuration for this plugin. | 24 | |
| ConfigurableInterface::getConfiguration | public | function | Gets this plugin's configuration. | 13 | |
| ConfigurableInterface::setConfiguration | public | function | Sets the configuration for this plugin instance. | 13 | |
| ContextAwarePluginInterface::getContext | public | function | Gets a defined context. | ||
| 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. | ||
| ContextAwarePluginInterface::getContextValue | public | function | Gets the value for a defined context. | ||
| ContextAwarePluginInterface::getContextValues | public | function | Gets the values for all defined contexts. | ||
| ContextAwarePluginInterface::setContext | public | function | Set a context on this plugin. | 1 | |
| 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. | ||
| ContextAwarePluginInterface::validateContexts | public | function | Validates the set values for the defined contexts. | ||
| DependentPluginInterface::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | 19 | |
| 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.
