class SectionLayout in Dashboards with Layout Builder 8

Add layout settings.

Layout plugin settings class.

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\dashboards\Layouts\SectionLayout implements PluginFormInterface

1 string reference to 'SectionLayout'

dashboards.layouts.yml in ./dashboards.layouts.yml

dashboards.layouts.yml

File

src/Layouts/SectionLayout.php, line 14

Namespace

Drupal\dashboards\Layouts

class SectionLayout extends LayoutDefault implements PluginFormInterface {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return parent::defaultConfiguration() + [
      'reverse' => FALSE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $configuration = $this
      ->getConfiguration();
    $form['reverse'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Reverse columns'),
      '#default_value' => $configuration['reverse'],
    ];
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function build(array $regions) {
    $configuration = $this
      ->getConfiguration();
    $build = parent::build($regions);
    if ($configuration['reverse']) {
      $build['#attributes']['class'][] = 'dashboard-reverse';
    }
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::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.
SectionLayout::build	public	function	Build a render array for layout with regions. Overrides LayoutDefault::build
SectionLayout::buildConfigurationForm	public	function	Form constructor. Overrides LayoutDefault::buildConfigurationForm
SectionLayout::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides LayoutDefault::defaultConfiguration
SectionLayout::submitConfigurationForm	public	function	Form submission handler. Overrides LayoutDefault::submitConfigurationForm
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.