class MultiWidthLayoutBase
Same name in other branches
- 9 core/modules/layout_builder/src/Plugin/Layout/MultiWidthLayoutBase.php \Drupal\layout_builder\Plugin\Layout\MultiWidthLayoutBase
- 10 core/modules/layout_builder/src/Plugin/Layout/MultiWidthLayoutBase.php \Drupal\layout_builder\Plugin\Layout\MultiWidthLayoutBase
- 11.x core/modules/layout_builder/src/Plugin/Layout/MultiWidthLayoutBase.php \Drupal\layout_builder\Plugin\Layout\MultiWidthLayoutBase
Base class of layouts with configurable widths.
@internal Plugin classes are internal.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Layout\LayoutDefault extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Layout\LayoutInterface, \Drupal\Core\Plugin\PluginFormInterface
- class \Drupal\layout_builder\Plugin\Layout\MultiWidthLayoutBase extends \Drupal\Core\Layout\LayoutDefault implements \Drupal\Core\Plugin\PluginFormInterface
- class \Drupal\Core\Layout\LayoutDefault extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Layout\LayoutInterface, \Drupal\Core\Plugin\PluginFormInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of MultiWidthLayoutBase
File
-
core/
modules/ layout_builder/ src/ Plugin/ Layout/ MultiWidthLayoutBase.php, line 15
Namespace
Drupal\layout_builder\Plugin\LayoutView source
abstract class MultiWidthLayoutBase extends LayoutDefault implements PluginFormInterface {
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
$configuration = parent::defaultConfiguration();
return $configuration + [
'column_widths' => $this->getDefaultWidth(),
];
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form['column_widths'] = [
'#type' => 'select',
'#title' => $this->t('Column widths'),
'#default_value' => $this->configuration['column_widths'],
'#options' => $this->getWidthOptions(),
'#description' => $this->t('Choose the column widths for this layout.'),
];
return parent::buildConfigurationForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
parent::submitConfigurationForm($form, $form_state);
$this->configuration['column_widths'] = $form_state->getValue('column_widths');
}
/**
* {@inheritdoc}
*/
public function build(array $regions) {
$build = parent::build($regions);
$build['#attributes']['class'] = [
'layout',
$this->getPluginDefinition()
->getTemplate(),
$this->getPluginDefinition()
->getTemplate() . '--' . $this->configuration['column_widths'],
];
return $build;
}
/**
* Gets the width options for the configuration form.
*
* The first option will be used as the default 'column_widths' configuration
* value.
*
* @return string[]
* The width options array where the keys are strings that will be added to
* the CSS classes and the values are the human readable labels.
*/
protected abstract function getWidthOptions();
/**
* Provides a default value for the width options.
*
* @return string
* A key from the array returned by ::getWidthOptions().
*/
protected function getDefaultWidth() {
// Return the first available key from the list of options.
$width_classes = array_keys($this->getWidthOptions());
return array_shift($width_classes);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
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::$pluginDefinition | protected | property | The layout definition. | ||
LayoutDefault::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | 2 |
LayoutDefault::getConfiguration | public | function | Gets this plugin's configuration. | Overrides ConfigurableInterface::getConfiguration | |
LayoutDefault::getPluginDefinition | public | function | Overrides LayoutInterface::getPluginDefinition | ||
LayoutDefault::setConfiguration | public | function | Sets the configuration for this plugin instance. | Overrides ConfigurableInterface::setConfiguration | |
LayoutDefault::validateConfigurationForm | public | function | Form validation handler. | Overrides PluginFormInterface::validateConfigurationForm | 1 |
LayoutDefault::__construct | public | function | |||
MultiWidthLayoutBase::build | public | function | Build a render array for layout with regions. | Overrides LayoutDefault::build | |
MultiWidthLayoutBase::buildConfigurationForm | public | function | Form constructor. | Overrides LayoutDefault::buildConfigurationForm | |
MultiWidthLayoutBase::defaultConfiguration | public | function | Gets default configuration for this plugin. | Overrides LayoutDefault::defaultConfiguration | |
MultiWidthLayoutBase::getDefaultWidth | protected | function | Provides a default value for the width options. | 2 | |
MultiWidthLayoutBase::getWidthOptions | abstract protected | function | Gets the width options for the configuration form. | 2 | |
MultiWidthLayoutBase::submitConfigurationForm | public | function | Form submission handler. | Overrides LayoutDefault::submitConfigurationForm | |
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.