1. class
  2. Drupal
  3. \
  4. Core
  5. \
  6. Layout
  7. \
  8. LayoutDefinition

LayoutDefinition

class LayoutDefinition extends PluginDefinition implements PluginDefinitionInterface, DerivablePluginDefinitionInterface, DependentPluginDefinitionInterface, ContextAwarePluginDefinitionInterface (View source)

Provides an implementation of a layout definition and its metadata.

Traits

ContextAwarePluginDefinitionTrait

Provides a trait for context-aware object-based plugin definitions.

DependentPluginDefinitionTrait

Provides a trait for a plugin definition that has dependencies.

Properties

protected string $id

The plugin ID.

 from  PluginDefinition
protected string $class

A fully qualified class name.

 from  PluginDefinition
protected string $provider

The plugin provider.

 from  PluginDefinition
protected ContextDefinitionInterface[] $contextDefinitions

The context definitions for this plugin definition.

 from  ContextAwarePluginDefinitionTrait
protected array $config_dependencies

The dependencies of this plugin definition.

 from  DependentPluginDefinitionTrait
protected string|null $deriver

The name of the deriver of this layout definition, if any.
protected string $label

The human-readable name.
protected string $description

An optional description for advanced layouts.
protected string $category

The human-readable category.
protected string|null $template

The template file to render this layout (relative to the 'path' given).
protected string $templatePath

The path to the template.
protected string|null $theme_hook

The theme hook used to render this layout.
protected string $path

Path (relative to the module or theme) to resources like icon or template.
protected string|null $library

The asset library.
protected string $icon

The path to the preview image.
protected string[][]|null $icon_map

An array defining the regions of a layout.
protected array $regions

An associative array of regions in this layout.
protected string $default_region

The default region.
protected array $additional

Any additional properties and values.

Methods

string
id()

Gets the unique identifier of the plugin.

from  PluginDefinition
PluginDefinitionInterface
setClass(string $class)

Sets the class.

from  PluginDefinition
string
getClass()

Gets the class.

from  PluginDefinition
string
getProvider()

Gets the plugin provider.

from  PluginDefinition
hasContextDefinition($name)

Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::hasContextDefinition().

from  ContextAwarePluginDefinitionTrait
getContextDefinitions()

Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::getContextDefinitions().

from  ContextAwarePluginDefinitionTrait
getContextDefinition($name)

Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::getContextDefinition().

from  ContextAwarePluginDefinitionTrait
addContextDefinition($name, ContextDefinitionInterface $definition)

Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::addContextDefinition().

from  ContextAwarePluginDefinitionTrait
removeContextDefinition($name)

Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::removeContextDefinition().

from  ContextAwarePluginDefinitionTrait
getConfigDependencies()

{@inheritdoc}

from  DependentPluginDefinitionTrait
setConfigDependencies(array $config_dependencies)

{@inheritdoc}

from  DependentPluginDefinitionTrait
__construct(array $definition)

LayoutDefinition constructor.

mixed
get(string $property)

Gets any arbitrary property.

$this
set(string $property, mixed $value)

Sets a value to an arbitrary property.

string|TranslatableMarkup
getLabel()

Gets the human-readable name of the layout definition.

$this
setLabel(string|TranslatableMarkup $label)

Sets the human-readable name of the layout definition.

string|TranslatableMarkup
getDescription()

Gets the description of the layout definition.

$this
setDescription(string|TranslatableMarkup $description)

Sets the description of the layout definition.

string|TranslatableMarkup
getCategory()

Gets the human-readable category of the layout definition.

$this
setCategory(string|TranslatableMarkup $category)

Sets the human-readable category of the layout definition.

string|null
getTemplate()

Gets the template name.

$this
setTemplate(string|null $template)

Sets the template name.

string
getTemplatePath()

Gets the template path.

$this
setTemplatePath(string $template_path)

Sets the template path.

string|null
getThemeHook()

Gets the theme hook.

$this
setThemeHook(string $theme_hook)

Sets the theme hook.

string
getPath()

Gets the base path for this layout definition.

$this
setPath(string $path)

Sets the base path for this layout definition.

string|null
getLibrary()

Gets the asset library for this layout definition.

$this
setLibrary(string|null $library)

Sets the asset library for this layout definition.

string|null
getIconPath()

Gets the icon path for this layout definition.

$this
setIconPath(string|null $icon)

Sets the icon path for this layout definition.

string[][]|null
getIconMap()

Gets the icon map for this layout definition.

$this
setIconMap(string[][]|null $icon_map)

Sets the icon map for this layout definition.

array
getIcon(int $width = 125, int $height = 150, int $stroke_width = NULL, int $padding = NULL)

Builds a render array for an icon representing the layout.

IconBuilderInterface
getIconBuilder()

Wraps the icon builder.

array[]
getRegions()

Gets the regions for this layout definition.

$this
setRegions(array $regions)

Sets the regions for this layout definition.

string[]
getRegionNames()

Gets the machine-readable region names.

string[]
getRegionLabels()

Gets the human-readable region labels.

string
getDefaultRegion()

Gets the default region.

$this
setDefaultRegion(string $default_region)

Sets the default region.

string|null
getDeriver()

Gets the name of the deriver of this plugin definition, if it exists.

$this
setDeriver(string|null $deriver)

Sets the deriver of this plugin definition.

Details

in PluginDefinition at line 34
string id()

Gets the unique identifier of the plugin.

Return Value

string

The unique identifier of the plugin.

in PluginDefinition at line 41
PluginDefinitionInterface setClass(string $class)

Sets the class.

Parameters

string $class

A fully qualified class name.

Return Value

PluginDefinitionInterface

Exceptions

InvalidArgumentException

in PluginDefinition at line 49
string getClass()

Gets the class.

Return Value

string

A fully qualified class name.

in PluginDefinition at line 56
string getProvider()

Gets the plugin provider.

The provider is the name of the module that provides the plugin, or "core', or "component".

Return Value

string

The provider.

in ContextAwarePluginDefinitionTrait at line 23
hasContextDefinition($name)

Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::hasContextDefinition().

Parameters

$name

in ContextAwarePluginDefinitionTrait at line 30
getContextDefinitions()

Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::getContextDefinitions().

in ContextAwarePluginDefinitionTrait at line 37
getContextDefinition($name)

Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::getContextDefinition().

Parameters

$name

in ContextAwarePluginDefinitionTrait at line 47
addContextDefinition($name, ContextDefinitionInterface $definition)

Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::addContextDefinition().

Parameters

$name
ContextDefinitionInterface $definition

in ContextAwarePluginDefinitionTrait at line 55
removeContextDefinition($name)

Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::removeContextDefinition().

Parameters

$name

in DependentPluginDefinitionTrait at line 22
getConfigDependencies()

{@inheritdoc}

in DependentPluginDefinitionTrait at line 29
setConfigDependencies(array $config_dependencies)

{@inheritdoc}

Parameters

array $config_dependencies

at line 134
__construct(array $definition)

LayoutDefinition constructor.

Parameters

array $definition

An array of values from the annotation.

at line 159
mixed get(string $property)

Gets any arbitrary property.

Parameters

string $property

The property to retrieve.

Return Value

mixed

The value for that property, or NULL if the property does not exist.

at line 179
$this set(string $property, mixed $value)

Sets a value to an arbitrary property.

Parameters

string $property

The property to use for the value.
mixed $value

The value to set.

Return Value

$this

at line 195
string|TranslatableMarkup getLabel()

Gets the human-readable name of the layout definition.

Return Value

string|TranslatableMarkup

The human-readable name of the layout definition.

at line 207
$this setLabel(string|TranslatableMarkup $label)

Sets the human-readable name of the layout definition.

Parameters

string|TranslatableMarkup $label

The human-readable name of the layout definition.

Return Value

$this

at line 218
string|TranslatableMarkup getDescription()

Gets the description of the layout definition.

Return Value

string|TranslatableMarkup

The description of the layout definition.

at line 230
$this setDescription(string|TranslatableMarkup $description)

Sets the description of the layout definition.

Parameters

string|TranslatableMarkup $description

The description of the layout definition.

Return Value

$this

at line 241
string|TranslatableMarkup getCategory()

Gets the human-readable category of the layout definition.

Return Value

string|TranslatableMarkup

The human-readable category of the layout definition.

at line 253
$this setCategory(string|TranslatableMarkup $category)

Sets the human-readable category of the layout definition.

Parameters

string|TranslatableMarkup $category

The human-readable category of the layout definition.

Return Value

$this

at line 264
string|null getTemplate()

Gets the template name.

Return Value

string|null

The template name, if it exists.

at line 276
$this setTemplate(string|null $template)

Sets the template name.

Parameters

string|null $template

The template name.

Return Value

$this

at line 287
string getTemplatePath()

Gets the template path.

Return Value

string

The template path.

at line 299
$this setTemplatePath(string $template_path)

Sets the template path.

Parameters

string $template_path

The template path.

Return Value

$this

at line 310
string|null getThemeHook()

Gets the theme hook.

Return Value

string|null

The theme hook, if it exists.

at line 322
$this setThemeHook(string $theme_hook)

Sets the theme hook.

Parameters

string $theme_hook

The theme hook.

Return Value

$this

at line 333
string getPath()

Gets the base path for this layout definition.

Return Value

string

The base path.

at line 345
$this setPath(string $path)

Sets the base path for this layout definition.

Parameters

string $path

The base path.

Return Value

$this

at line 356
string|null getLibrary()

Gets the asset library for this layout definition.

Return Value

string|null

The asset library, if it exists.

at line 368
$this setLibrary(string|null $library)

Sets the asset library for this layout definition.

Parameters

string|null $library

The asset library.

Return Value

$this

at line 379
string|null getIconPath()

Gets the icon path for this layout definition.

Return Value

string|null

The icon path, if it exists.

at line 391
$this setIconPath(string|null $icon)

Sets the icon path for this layout definition.

Parameters

string|null $icon

The icon path.

Return Value

$this

at line 404
string[][]|null getIconMap()

Gets the icon map for this layout definition.

This should not be used if an icon path is specified. See ::getIcon().

Return Value

string[][]|null

The icon map, if it exists.

at line 416
$this setIconMap(string[][]|null $icon_map)

Sets the icon map for this layout definition.

Parameters

string[][]|null $icon_map

The icon map.

Return Value

$this

at line 437
array getIcon(int $width = 125, int $height = 150, int $stroke_width = NULL, int $padding = NULL)

Builds a render array for an icon representing the layout.

Parameters

int $width

(optional) The width of the icon. Defaults to 125.
int $height

(optional) The height of the icon. Defaults to 150.
int $stroke_width

(optional) If an icon map is used, the width of region borders.
int $padding

(optional) If an icon map is used, the padding between regions. Any value above 0 is valid.

Return Value

array

A render array for the icon.

at line 471
protected IconBuilderInterface getIconBuilder()

Wraps the icon builder.

Return Value

IconBuilderInterface

The icon builder.

at line 485
array[] getRegions()

Gets the regions for this layout definition.

Return Value

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.

at line 497
$this setRegions(array $regions)

Sets the regions for this layout definition.

Parameters

array $regions

An array of regions, see ::getRegions() for the format.

Return Value

$this

at line 508
string[] getRegionNames()

Gets the machine-readable region names.

Return Value

string[]

An array of machine-readable region names.

at line 518
string[] getRegionLabels()

Gets the human-readable region labels.

Return Value

string[]

An array of human-readable region labels.

at line 529
string getDefaultRegion()

Gets the default region.

Return Value

string

The machine-readable name of the default region.

at line 541
$this setDefaultRegion(string $default_region)

Sets the default region.

Parameters

string $default_region

The machine-readable name of the default region.

Return Value

$this

at line 549
string|null getDeriver()

Gets the name of the deriver of this plugin definition, if it exists.

Return Value

string|null

Either the deriver class name, or NULL if the plugin is not derived.

at line 556
$this setDeriver(string|null $deriver)

Sets the deriver of this plugin definition.

Parameters

string|null $deriver

Either the name of a class that implements \Drupal\Component\Plugin\Derivative\DeriverInterface, or NULL.

Return Value

$this