abstract class LayoutBase in Layout Plugin (obsolete, use core's Layout Discovery) 8

Provides a base class for Layout plugins.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\layout_plugin\Plugin\Layout\LayoutBase implements ConfigurablePluginInterface, PluginFormInterface, LayoutInterface

Expanded class hierarchy of LayoutBase

2 files declare their use of LayoutBase

LayoutExampleTest.php in modules/layout_plugin_example/src/Plugin/Layout/LayoutExampleTest.php
LayoutTestPlugin.php in tests/modules/layout_test/src/Plugin/Layout/LayoutTestPlugin.php

File

src/Plugin/Layout/LayoutBase.php, line 13

Namespace

Drupal\layout_plugin\Plugin\Layout

View source

abstract class LayoutBase extends PluginBase implements LayoutInterface, ConfigurablePluginInterface, PluginFormInterface {

  /**
   * The layout configuration.
   *
   * @var array
   */
  protected $configuration = [];

  /**
   * Gets the human-readable name.
   *
   * @return \Drupal\Core\Annotation\Translation|NULL
   *   The human-readable name.
   */
  public function getLabel() {
    return $this->pluginDefinition['label'];
  }

  /**
   * Gets the optional description for advanced layouts.
   *
   * @return \Drupal\Core\Annotation\Translation|NULL
   *   The layout description.
   */
  public function getDescription() {
    return isset($this->pluginDefinition['description']) ? $this->pluginDefinition['description'] : NULL;
  }

  /**
   * Gets the human-readable category.
   *
   * @return \Drupal\Core\Annotation\Translation
   *   The human-readable category.
   */
  public function getCategory() {
    return $this->pluginDefinition['category'];
  }

  /**
   * Gets human-readable list of regions keyed by machine name.
   *
   * @return \Drupal\Core\Annotation\Translation[]
   *   An array of human-readable region names keyed by machine name.
   */
  public function getRegionNames() {
    return $this->pluginDefinition['region_names'];
  }

  /**
   * Gets information on regions keyed by machine name.
   *
   * @return array
   *   An array of information on regions keyed by machine name.
   */
  public function getRegionDefinitions() {
    return $this->pluginDefinition['regions'];
  }

  /**
   * Gets the path to resources like icon or template.
   *
   * @return string|NULL
   *   The path relative to the Drupal root.
   */
  public function getBasePath() {
    return isset($this->pluginDefinition['path']) ? $this->pluginDefinition['path'] : NULL;
  }

  /**
   * Gets the path to the preview image.
   *
   * This can optionally be used in the user interface to show the layout of
   * regions visually.
   *
   * @return string|NULL
   *   The path to preview image file.
   */
  public function getIconFilename() {
    return isset($this->pluginDefinition['icon']) ? $this->pluginDefinition['icon'] : NULL;
  }

  /**
   * Get the asset library.
   *
   * @return string|NULL
   *   The asset library.
   */
  public function getLibrary() {
    return isset($this->pluginDefinition['library']) ? $this->pluginDefinition['library'] : NULL;
  }

  /**
   * Gets the theme hook used to render this layout.
   *
   * @return string|NULL
   *   Theme hook.
   */
  public function getThemeHook() {
    return isset($this->pluginDefinition['theme']) ? $this->pluginDefinition['theme'] : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function build(array $regions) {
    $build = array_intersect_key($regions, $this
      ->getRegionDefinitions());
    $build['#layout'] = $this
      ->getPluginDefinition();
    $build['#settings'] = $this
      ->getConfiguration();
    if ($theme = $this
      ->getThemeHook()) {
      $build['#theme'] = $theme;
    }
    if ($library = $this
      ->getLibrary()) {
      $build['#attached']['library'][] = $library;
    }
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

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

  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return array_merge($this
      ->defaultConfiguration(), $this->configuration);
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = $configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return isset($this->configuration['dependencies']) ? $this->configuration['dependencies'] : [];
  }

}

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
LayoutBase::$configuration	protected	property	The layout configuration. Overrides PluginBase::$configuration
LayoutBase::build	public	function	Build a render array for layout with regions. Overrides LayoutInterface::build
LayoutBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	2
LayoutBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
LayoutBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurablePluginInterface::defaultConfiguration	2
LayoutBase::getBasePath	public	function	Gets the path to resources like icon or template.
LayoutBase::getCategory	public	function	Gets the human-readable category.
LayoutBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration
LayoutBase::getDescription	public	function	Gets the optional description for advanced layouts.
LayoutBase::getIconFilename	public	function	Gets the path to the preview image.
LayoutBase::getLabel	public	function	Gets the human-readable name.
LayoutBase::getLibrary	public	function	Get the asset library.
LayoutBase::getRegionDefinitions	public	function	Gets information on regions keyed by machine name.
LayoutBase::getRegionNames	public	function	Gets human-readable list of regions keyed by machine name.
LayoutBase::getThemeHook	public	function	Gets the theme hook used to render this layout.
LayoutBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration
LayoutBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	2
LayoutBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	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::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.

You are here

abstract class LayoutBase in Layout Plugin (obsolete, use core's Layout Discovery) 8

Hierarchy

File

Namespace

Members

API Navigation