class LayoutDefault

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Layout/LayoutDefault.php \Drupal\Core\Layout\LayoutDefault
  2. 8.9.x core/lib/Drupal/Core/Layout/LayoutDefault.php \Drupal\Core\Layout\LayoutDefault
  3. 11.x core/lib/Drupal/Core/Layout/LayoutDefault.php \Drupal\Core\Layout\LayoutDefault

Provides a default class for Layout plugins.

Hierarchy

Expanded class hierarchy of LayoutDefault

15 files declare their use of LayoutDefault
BlankLayout.php in core/modules/layout_builder/src/Plugin/Layout/BlankLayout.php
FieldLayoutBuilderTest.php in core/modules/field_layout/tests/src/Unit/FieldLayoutBuilderTest.php
Layout.php in core/lib/Drupal/Core/Layout/Annotation/Layout.php
Layout.php in core/lib/Drupal/Core/Layout/Attribute/Layout.php
LayoutBuilderTestPlugin.php in core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/Layout/LayoutBuilderTestPlugin.php

... See full list

2 string references to 'LayoutDefault'
test_child_theme.layouts.yml in core/modules/system/tests/themes/test_child_theme/test_child_theme.layouts.yml
core/modules/system/tests/themes/test_child_theme/test_child_theme.layouts.yml
test_parent_theme.layouts.yml in core/modules/system/tests/themes/test_parent_theme/test_parent_theme.layouts.yml
core/modules/system/tests/themes/test_parent_theme/test_parent_theme.layouts.yml

File

core/lib/Drupal/Core/Layout/LayoutDefault.php, line 16

Namespace

Drupal\Core\Layout
View source
class LayoutDefault extends PluginBase implements LayoutInterface, PluginFormInterface, PreviewAwarePluginInterface {
  use ContextAwarePluginAssignmentTrait;
  use ContextAwarePluginTrait;
  
  /**
   * Whether the plugin is being rendered in preview mode.
   *
   * @var bool
   */
  protected $inPreview = FALSE;
  
  /**
   * The layout definition.
   *
   * @var \Drupal\Core\Layout\LayoutDefinition
   */
  protected $pluginDefinition;
  
  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->setConfiguration($configuration);
  }
  
  /**
   * {@inheritdoc}
   */
  public function build(array $regions) {
    // Ensure $build only contains defined regions and in the order defined.
    $build = [];
    foreach ($this->getPluginDefinition()
      ->getRegionNames() as $region_name) {
      if (array_key_exists($region_name, $regions)) {
        $build[$region_name] = $regions[$region_name];
      }
    }
    $build['#in_preview'] = $this->inPreview;
    $build['#settings'] = $this->getConfiguration();
    $build['#layout'] = $this->pluginDefinition;
    $build['#theme'] = $this->pluginDefinition
      ->getThemeHook();
    if ($library = $this->pluginDefinition
      ->getLibrary()) {
      $build['#attached']['library'][] = $library;
    }
    return $build;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return $this->configuration;
  }
  
  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = NestedArray::mergeDeep($this->defaultConfiguration(), $configuration);
  }
  
  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'label' => '',
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return [];
  }
  
  /**
   * {@inheritdoc}
   *
   * @return \Drupal\Core\Layout\LayoutDefinition
   */
  public function getPluginDefinition() {
    return parent::getPluginDefinition();
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['label'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Administrative label'),
      '#default_value' => $this->configuration['label'],
    ];
    $contexts = $form_state->getTemporaryValue('gathered_contexts') ?: [];
    $form['context_mapping'] = $this->addContextAssignmentElement($this, $contexts);
    return $form;
  }
  
  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
  }
  
  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration['label'] = $form_state->getValue('label');
  }
  
  /**
   * {@inheritdoc}
   */
  public function setInPreview(bool $in_preview) : void {
    $this->inPreview = $in_preview;
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginAssignmentTrait::t abstract protected function Ensures the t() method is available.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::getCacheContexts public function 10
ContextAwarePluginTrait::getCacheMaxAge public function 6
ContextAwarePluginTrait::getCacheTags public function 3
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function 1
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
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
LayoutDefault::$inPreview protected property Whether the plugin is being rendered in preview mode.
LayoutDefault::$pluginDefinition protected property The layout definition.
LayoutDefault::build public function Build a render array for layout with regions. Overrides LayoutInterface::build 5
LayoutDefault::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 3
LayoutDefault::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 2
LayoutDefault::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 4
LayoutDefault::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
LayoutDefault::getPluginDefinition public function Overrides ContextAwarePluginTrait::getPluginDefinition
LayoutDefault::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
LayoutDefault::setInPreview public function Set preview mode for the plugin. Overrides PreviewAwarePluginInterface::setInPreview
LayoutDefault::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 3
LayoutDefault::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 1
LayoutDefault::__construct public function
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.