class ClassyLayout in Layout Section Classes 8

A layout plugin class for layouts with selectable classes.

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
      • class \Drupal\layout_section_classes\ClassyLayout implements PluginFormInterface

2 files declare their use of ClassyLayout

LayoutClassesPluginDefinitionFormatTest.php in tests/src/Unit/LayoutClassesPluginDefinitionFormatTest.php

layout_section_classes.module in ./layout_section_classes.module

Module file.

File

src/ClassyLayout.php, line 12

Namespace

Drupal\layout_section_classes

class ClassyLayout extends LayoutDefault implements PluginFormInterface {

  /**
   * {@inheritdoc}
   */
  public function build(array $regions) {
    $build = parent::build($regions);
    $classes = $this->configuration['additional']['classes'] ?? [];
    $build['#attributes']['class'] = $build['#attributes']['class'] ?? [];
    foreach ($classes as $class_set) {
      if (is_string($class_set) && $class_set) {
        $build['#attributes']['class'][] = $class_set;
      }
      if (is_array($class_set)) {
        $build['#attributes']['class'] = array_merge($build['#attributes']['class'], array_filter($class_set));
      }
    }
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['classes'] = [
      '#type' => 'container',
      '#tree' => TRUE,
    ];
    $plugin_configuration = $this->configuration['additional']['classes'] ?? [];
    foreach ($this
      ->getPluginDefinition()
      ->get('classes') as $key => $class_definition) {
      if (!is_array($class_definition['options']) || empty($class_definition['options'])) {
        throw new \Exception('The "options" key is required for layout class definitions.');
      }
      $definition_default = $class_definition['default'] ?? NULL;
      $form['classes'][$key] = [
        '#title' => $class_definition['label'] ?? $this
          ->t('Classes'),
        '#type' => 'select',
        '#multiple' => $class_definition['multiple'] ?? FALSE,
        '#options' => $class_definition['options'],
        '#required' => $class_definition['required'] ?? FALSE,
        '#default_value' => $plugin_configuration[$key] ?? $definition_default,
        '#description' => $class_definition['description'] ?? '',
      ];

      // Add an empty option if the selection is option or it's required with no
      // default.
      if (!$form['classes'][$key]['#required'] || $form['classes'][$key]['#required'] && $form['classes'][$key]['#default_value'] === NULL) {
        $form['classes'][$key]['#empty_option'] = $this
          ->t('- Select -');
      }
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['additional']['classes'] = $form_state
      ->getValue('classes');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ClassyLayout::build	public	function	Build a render array for layout with regions. Overrides LayoutDefault::build
ClassyLayout::buildConfigurationForm	public	function	Form constructor. Overrides LayoutDefault::buildConfigurationForm
ClassyLayout::submitConfigurationForm	public	function	Form submission handler. Overrides LayoutDefault::submitConfigurationForm
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
LayoutDefault::$pluginDefinition	protected	property	The layout definition. Overrides PluginBase::$pluginDefinition
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	3
LayoutDefault::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
LayoutDefault::getPluginDefinition	public	function	Overrides PluginBase::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	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.