class LayoutDefinition in Drupal 10

Same name and namespace in other branches

8 core/lib/Drupal/Core/Layout/LayoutDefinition.php \Drupal\Core\Layout\LayoutDefinition
9 core/lib/Drupal/Core/Layout/LayoutDefinition.php \Drupal\Core\Layout\LayoutDefinition

Provides an implementation of a layout definition and its metadata.

Hierarchy

class \Drupal\Component\Plugin\Definition\PluginDefinition implements PluginDefinitionInterface
- class \Drupal\Core\Layout\LayoutDefinition implements ContextAwarePluginDefinitionInterface, DerivablePluginDefinitionInterface, PluginDefinitionInterface, DependentPluginDefinitionInterface uses ContextAwarePluginDefinitionTrait, DependentPluginDefinitionTrait

Expanded class hierarchy of LayoutDefinition

5 files declare their use of LayoutDefinition

FieldLayoutBuilderTest.php in core/modules/field_layout/tests/src/Unit/FieldLayoutBuilderTest.php
Layout.php in core/lib/Drupal/Core/Layout/Annotation/Layout.php
LayoutDefaultTest.php in core/tests/Drupal/Tests/Core/Layout/LayoutDefaultTest.php
LayoutPluginManagerTest.php in core/tests/Drupal/Tests/Core/Layout/LayoutPluginManagerTest.php
SectionRenderTest.php in core/modules/layout_builder/tests/src/Unit/SectionRenderTest.php

File

core/lib/Drupal/Core/Layout/LayoutDefinition.php, line 16

Namespace

Drupal\Core\Layout

View source

class LayoutDefinition extends PluginDefinition implements PluginDefinitionInterface, DerivablePluginDefinitionInterface, DependentPluginDefinitionInterface, ContextAwarePluginDefinitionInterface {
  use ContextAwarePluginDefinitionTrait;
  use DependentPluginDefinitionTrait;

  /**
   * The name of the deriver of this layout definition, if any.
   *
   * @var string|null
   */
  protected $deriver;

  /**
   * The human-readable name.
   *
   * @var string
   */
  protected $label;

  /**
   * An optional description for advanced layouts.
   *
   * @var string
   */
  protected $description;

  /**
   * The human-readable category.
   *
   * @var string
   */
  protected $category;

  /**
   * The template file to render this layout (relative to the 'path' given).
   *
   * @var string|null
   */
  protected $template;

  /**
   * The path to the template.
   *
   * @var string
   */
  protected $templatePath;

  /**
   * The theme hook used to render this layout.
   *
   * @var string|null
   */
  protected $theme_hook;

  /**
   * Path (relative to the module or theme) to resources like icon or template.
   *
   * @var string
   */
  protected $path;

  /**
   * The asset library.
   *
   * @var string|null
   */
  protected $library;

  /**
   * The path to the preview image.
   *
   * @var string
   */
  protected $icon;

  /**
   * An array defining the regions of a layout.
   *
   * @var string[][]|null
   *
   * @see \Drupal\Core\Layout\Icon\IconBuilderInterface::build()
   */
  protected $icon_map;

  /**
   * An associative array of regions in this layout.
   *
   * The key of the array is the machine name of the region, and the value is
   * an associative array with the following keys:
   * - label: (string) The human-readable name of the region.
   *
   * Any remaining keys may have special meaning for the given layout plugin,
   * but are undefined here.
   *
   * @var array
   */
  protected $regions = [];

  /**
   * The default region.
   *
   * @var string
   */
  protected $default_region;

  /**
   * Any additional properties and values.
   *
   * @var array
   */
  protected $additional = [];

  /**
   * LayoutDefinition constructor.
   *
   * @param array $definition
   *   An array of values from the annotation.
   */
  public function __construct(array $definition) {

    // If there are context definitions in the plugin definition, they should
    // be added to this object using ::addContextDefinition() so that they can
    // be manipulated using other ContextAwarePluginDefinitionInterface methods.
    if (isset($definition['context_definitions'])) {
      foreach ($definition['context_definitions'] as $name => $context_definition) {
        $this
          ->addContextDefinition($name, $context_definition);
      }
      unset($definition['context_definitions']);
    }
    foreach ($definition as $property => $value) {
      $this
        ->set($property, $value);
    }
  }

  /**
   * Gets any arbitrary property.
   *
   * @param string $property
   *   The property to retrieve.
   *
   * @return mixed
   *   The value for that property, or NULL if the property does not exist.
   */
  public function get($property) {
    if (property_exists($this, $property)) {
      $value = $this->{$property} ?? NULL;
    }
    else {
      $value = $this->additional[$property] ?? NULL;
    }
    return $value;
  }

  /**
   * Sets a value to an arbitrary property.
   *
   * @param string $property
   *   The property to use for the value.
   * @param mixed $value
   *   The value to set.
   *
   * @return $this
   */
  public function set($property, $value) {
    if (property_exists($this, $property)) {
      $this->{$property} = $value;
    }
    else {
      $this->additional[$property] = $value;
    }
    return $this;
  }

  /**
   * Gets the human-readable name of the layout definition.
   *
   * @return string|\Drupal\Core\StringTranslation\TranslatableMarkup
   *   The human-readable name of the layout definition.
   */
  public function getLabel() {
    return $this->label;
  }

  /**
   * Sets the human-readable name of the layout definition.
   *
   * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $label
   *   The human-readable name of the layout definition.
   *
   * @return $this
   */
  public function setLabel($label) {
    $this->label = $label;
    return $this;
  }

  /**
   * Gets the description of the layout definition.
   *
   * @return string|\Drupal\Core\StringTranslation\TranslatableMarkup
   *   The description of the layout definition.
   */
  public function getDescription() {
    return $this->description;
  }

  /**
   * Sets the description of the layout definition.
   *
   * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $description
   *   The description of the layout definition.
   *
   * @return $this
   */
  public function setDescription($description) {
    $this->description = $description;
    return $this;
  }

  /**
   * Gets the human-readable category of the layout definition.
   *
   * @return string|\Drupal\Core\StringTranslation\TranslatableMarkup
   *   The human-readable category of the layout definition.
   */
  public function getCategory() {
    return $this->category;
  }

  /**
   * Sets the human-readable category of the layout definition.
   *
   * @param string|\Drupal\Core\StringTranslation\TranslatableMarkup $category
   *   The human-readable category of the layout definition.
   *
   * @return $this
   */
  public function setCategory($category) {
    $this->category = $category;
    return $this;
  }

  /**
   * Gets the template name.
   *
   * @return string|null
   *   The template name, if it exists.
   */
  public function getTemplate() {
    return $this->template;
  }

  /**
   * Sets the template name.
   *
   * @param string|null $template
   *   The template name.
   *
   * @return $this
   */
  public function setTemplate($template) {
    $this->template = $template;
    return $this;
  }

  /**
   * Gets the template path.
   *
   * @return string
   *   The template path.
   */
  public function getTemplatePath() {
    return $this->templatePath;
  }

  /**
   * Sets the template path.
   *
   * @param string $template_path
   *   The template path.
   *
   * @return $this
   */
  public function setTemplatePath($template_path) {
    $this->templatePath = $template_path;
    return $this;
  }

  /**
   * Gets the theme hook.
   *
   * @return string|null
   *   The theme hook, if it exists.
   */
  public function getThemeHook() {
    return $this->theme_hook;
  }

  /**
   * Sets the theme hook.
   *
   * @param string $theme_hook
   *   The theme hook.
   *
   * @return $this
   */
  public function setThemeHook($theme_hook) {
    $this->theme_hook = $theme_hook;
    return $this;
  }

  /**
   * Gets the base path for this layout definition.
   *
   * @return string
   *   The base path.
   */
  public function getPath() {
    return $this->path;
  }

  /**
   * Sets the base path for this layout definition.
   *
   * @param string $path
   *   The base path.
   *
   * @return $this
   */
  public function setPath($path) {
    $this->path = $path;
    return $this;
  }

  /**
   * Gets the asset library for this layout definition.
   *
   * @return string|null
   *   The asset library, if it exists.
   */
  public function getLibrary() {
    return $this->library;
  }

  /**
   * Sets the asset library for this layout definition.
   *
   * @param string|null $library
   *   The asset library.
   *
   * @return $this
   */
  public function setLibrary($library) {
    $this->library = $library;
    return $this;
  }

  /**
   * Gets the icon path for this layout definition.
   *
   * @return string|null
   *   The icon path, if it exists.
   */
  public function getIconPath() {
    return $this->icon;
  }

  /**
   * Sets the icon path for this layout definition.
   *
   * @param string|null $icon
   *   The icon path.
   *
   * @return $this
   */
  public function setIconPath($icon) {
    $this->icon = $icon;
    return $this;
  }

  /**
   * Gets the icon map for this layout definition.
   *
   * This should not be used if an icon path is specified. See ::getIcon().
   *
   * @return string[][]|null
   *   The icon map, if it exists.
   */
  public function getIconMap() {
    return $this->icon_map;
  }

  /**
   * Sets the icon map for this layout definition.
   *
   * @param string[][]|null $icon_map
   *   The icon map.
   *
   * @return $this
   */
  public function setIconMap($icon_map) {
    $this->icon_map = $icon_map;
    return $this;
  }

  /**
   * Builds a render array for an icon representing the layout.
   *
   * @param int $width
   *   (optional) The width of the icon. Defaults to 125.
   * @param int $height
   *   (optional) The height of the icon. Defaults to 150.
   * @param int $stroke_width
   *   (optional) If an icon map is used, the width of region borders.
   * @param int $padding
   *   (optional) If an icon map is used, the padding between regions. Any
   *   value above 0 is valid.
   *
   * @return array
   *   A render array for the icon.
   */
  public function getIcon($width = 125, $height = 150, $stroke_width = NULL, $padding = NULL) {
    $icon = [];
    if ($icon_path = $this
      ->getIconPath()) {
      $icon = [
        '#theme' => 'image',
        '#uri' => $icon_path,
        '#width' => $width,
        '#height' => $height,
        '#alt' => $this
          ->getLabel(),
      ];
    }
    elseif ($icon_map = $this
      ->getIconMap()) {
      $icon_builder = $this
        ->getIconBuilder()
        ->setId($this
        ->id())
        ->setLabel($this
        ->getLabel())
        ->setWidth($width)
        ->setHeight($height);
      if ($padding) {
        $icon_builder
          ->setPadding($padding);
      }
      if ($stroke_width) {
        $icon_builder
          ->setStrokeWidth($stroke_width);
      }
      $icon = $icon_builder
        ->build($icon_map);
    }
    return $icon;
  }

  /**
   * Wraps the icon builder.
   *
   * @return \Drupal\Core\Layout\Icon\IconBuilderInterface
   *   The icon builder.
   */
  protected function getIconBuilder() {
    return \Drupal::service('layout.icon_builder');
  }

  /**
   * Gets the regions for this layout definition.
   *
   * @return array[]
   *   The layout regions. The keys of the array are the machine names of the
   *   regions, and the values are an associative array with the following keys:
   *   - label: (string) The human-readable name of the region.
   *   Any remaining keys may have special meaning for the given layout plugin,
   *   but are undefined here.
   */
  public function getRegions() {
    return $this->regions;
  }

  /**
   * Sets the regions for this layout definition.
   *
   * @param array[] $regions
   *   An array of regions, see ::getRegions() for the format.
   *
   * @return $this
   */
  public function setRegions(array $regions) {
    $this->regions = $regions;
    return $this;
  }

  /**
   * Gets the machine-readable region names.
   *
   * @return string[]
   *   An array of machine-readable region names.
   */
  public function getRegionNames() {
    return array_keys($this
      ->getRegions());
  }

  /**
   * Gets the human-readable region labels.
   *
   * @return string[]
   *   An array of human-readable region labels.
   */
  public function getRegionLabels() {
    $regions = $this
      ->getRegions();
    return array_combine(array_keys($regions), array_column($regions, 'label'));
  }

  /**
   * Gets the default region.
   *
   * @return string
   *   The machine-readable name of the default region.
   */
  public function getDefaultRegion() {
    return $this->default_region;
  }

  /**
   * Sets the default region.
   *
   * @param string $default_region
   *   The machine-readable name of the default region.
   *
   * @return $this
   */
  public function setDefaultRegion($default_region) {
    $this->default_region = $default_region;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getDeriver() {
    return $this->deriver;
  }

  /**
   * {@inheritdoc}
   */
  public function setDeriver($deriver) {
    $this->deriver = $deriver;
    return $this;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContextAwarePluginDefinitionTrait::$contextDefinitions	protected	property	The context definitions for this plugin definition.
ContextAwarePluginDefinitionTrait::addContextDefinition	public	function	Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::addContextDefinition().
ContextAwarePluginDefinitionTrait::getContextDefinition	public	function	Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::getContextDefinition().
ContextAwarePluginDefinitionTrait::getContextDefinitions	public	function	Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::getContextDefinitions().
ContextAwarePluginDefinitionTrait::hasContextDefinition	public	function	Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::hasContextDefinition().
ContextAwarePluginDefinitionTrait::removeContextDefinition	public	function	Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::removeContextDefinition().
DependentPluginDefinitionTrait::$config_dependencies	protected	property	The dependencies of this plugin definition.
DependentPluginDefinitionTrait::getConfigDependencies	public	function
DependentPluginDefinitionTrait::setConfigDependencies	public	function
LayoutDefinition::$additional	protected	property	Any additional properties and values.
LayoutDefinition::$category	protected	property	The human-readable category.
LayoutDefinition::$default_region	protected	property	The default region.
LayoutDefinition::$deriver	protected	property	The name of the deriver of this layout definition, if any.
LayoutDefinition::$description	protected	property	An optional description for advanced layouts.
LayoutDefinition::$icon	protected	property	The path to the preview image.
LayoutDefinition::$icon_map	protected	property	An array defining the regions of a layout.
LayoutDefinition::$label	protected	property	The human-readable name.
LayoutDefinition::$library	protected	property	The asset library.
LayoutDefinition::$path	protected	property	Path (relative to the module or theme) to resources like icon or template.
LayoutDefinition::$regions	protected	property	An associative array of regions in this layout.
LayoutDefinition::$template	protected	property	The template file to render this layout (relative to the 'path' given).
LayoutDefinition::$templatePath	protected	property	The path to the template.
LayoutDefinition::$theme_hook	protected	property	The theme hook used to render this layout.
LayoutDefinition::get	public	function	Gets any arbitrary property.
LayoutDefinition::getCategory	public	function	Gets the human-readable category of the layout definition.
LayoutDefinition::getDefaultRegion	public	function	Gets the default region.
LayoutDefinition::getDeriver	public	function	Gets the name of the deriver of this plugin definition, if it exists. Overrides DerivablePluginDefinitionInterface::getDeriver
LayoutDefinition::getDescription	public	function	Gets the description of the layout definition.
LayoutDefinition::getIcon	public	function	Builds a render array for an icon representing the layout.
LayoutDefinition::getIconBuilder	protected	function	Wraps the icon builder.
LayoutDefinition::getIconMap	public	function	Gets the icon map for this layout definition.
LayoutDefinition::getIconPath	public	function	Gets the icon path for this layout definition.
LayoutDefinition::getLabel	public	function	Gets the human-readable name of the layout definition.
LayoutDefinition::getLibrary	public	function	Gets the asset library for this layout definition.
LayoutDefinition::getPath	public	function	Gets the base path for this layout definition.
LayoutDefinition::getRegionLabels	public	function	Gets the human-readable region labels.
LayoutDefinition::getRegionNames	public	function	Gets the machine-readable region names.
LayoutDefinition::getRegions	public	function	Gets the regions for this layout definition.
LayoutDefinition::getTemplate	public	function	Gets the template name.
LayoutDefinition::getTemplatePath	public	function	Gets the template path.
LayoutDefinition::getThemeHook	public	function	Gets the theme hook.
LayoutDefinition::set	public	function	Sets a value to an arbitrary property.
LayoutDefinition::setCategory	public	function	Sets the human-readable category of the layout definition.
LayoutDefinition::setDefaultRegion	public	function	Sets the default region.
LayoutDefinition::setDeriver	public	function	Sets the deriver of this plugin definition. Overrides DerivablePluginDefinitionInterface::setDeriver
LayoutDefinition::setDescription	public	function	Sets the description of the layout definition.
LayoutDefinition::setIconMap	public	function	Sets the icon map for this layout definition.
LayoutDefinition::setIconPath	public	function	Sets the icon path for this layout definition.
LayoutDefinition::setLabel	public	function	Sets the human-readable name of the layout definition.
LayoutDefinition::setLibrary	public	function	Sets the asset library for this layout definition.
LayoutDefinition::setPath	public	function	Sets the base path for this layout definition.
LayoutDefinition::setRegions	public	function	Sets the regions for this layout definition.
LayoutDefinition::setTemplate	public	function	Sets the template name.
LayoutDefinition::setTemplatePath	public	function	Sets the template path.
LayoutDefinition::setThemeHook	public	function	Sets the theme hook.
LayoutDefinition::__construct	public	function	LayoutDefinition constructor.
PluginDefinition::$class	protected	property	A fully qualified class name.
PluginDefinition::$id	protected	property	The plugin ID.	1
PluginDefinition::$provider	protected	property	The plugin provider.
PluginDefinition::getClass	public	function	Gets the class. Overrides PluginDefinitionInterface::getClass	1
PluginDefinition::getProvider	public	function	Gets the plugin provider. Overrides PluginDefinitionInterface::getProvider
PluginDefinition::id	public	function	Gets the unique identifier of the plugin. Overrides PluginDefinitionInterface::id	1
PluginDefinition::setClass	public	function	Sets the class. Overrides PluginDefinitionInterface::setClass	2

You are here

class LayoutDefinition in Drupal 10

Hierarchy

File

Namespace

Members

API Navigation