class LayoutDefault in Drupal 9
Same name and namespace in other branches
- 8 core/lib/Drupal/Core/Layout/LayoutDefault.php \Drupal\Core\Layout\LayoutDefault
Provides a default class for Layout plugins.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Layout\LayoutDefault implements LayoutInterface, PluginFormInterface uses ContextAwarePluginAssignmentTrait, ContextAwarePluginTrait
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of LayoutDefault
13 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 - LayoutBuilderTestPlugin.php in core/
modules/ layout_builder/ tests/ modules/ layout_builder_test/ src/ Plugin/ Layout/ LayoutBuilderTestPlugin.php - LayoutDefaultTest.php in core/
tests/ Drupal/ Tests/ Core/ Layout/ LayoutDefaultTest.php
File
- core/
lib/ Drupal/ Core/ Layout/ LayoutDefault.php, line 15
Namespace
Drupal\Core\LayoutView source
class LayoutDefault extends PluginBase implements LayoutInterface, PluginFormInterface {
use ContextAwarePluginAssignmentTrait;
use ContextAwarePluginTrait;
/**
* 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['#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');
}
}