123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548 |
- <?php
- namespace Drupal\Core\Layout;
- use Drupal\Component\Plugin\Definition\DerivablePluginDefinitionInterface;
- use Drupal\Component\Plugin\Definition\PluginDefinitionInterface;
- use Drupal\Component\Plugin\Definition\PluginDefinition;
- use Drupal\Core\Plugin\Definition\DependentPluginDefinitionInterface;
- use Drupal\Core\Plugin\Definition\DependentPluginDefinitionTrait;
- /**
- * Provides an implementation of a layout definition and its metadata.
- */
- class LayoutDefinition extends PluginDefinition implements PluginDefinitionInterface, DerivablePluginDefinitionInterface, DependentPluginDefinitionInterface {
- 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) {
- 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 = isset($this->{$property}) ? $this->{$property} : NULL;
- }
- else {
- $value = isset($this->additional[$property]) ? $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;
- }
- }
|