class PatternDefinition in UI Patterns 8

Class PatternDefinition.

@package Drupal\ui_patterns\Definition

Hierarchy

class \Drupal\Component\Plugin\Definition\PluginDefinition implements PluginDefinitionInterface
- class \Drupal\ui_patterns\Definition\PatternDefinition implements \Drupal\ui_patterns\Definition\ArrayAccess, DerivablePluginDefinitionInterface uses ArrayAccessDefinitionTrait

Expanded class hierarchy of PatternDefinition

6 files declare their use of PatternDefinition

AbstractPatternsDeriver.php in src/Plugin/Deriver/AbstractPatternsDeriver.php
LibraryPattern.php in modules/ui_patterns_library/src/Plugin/UiPatterns/Pattern/LibraryPattern.php
PatternBase.php in src/Plugin/PatternBase.php
PatternDefinitionTest.php in tests/src/Unit/Definition/PatternDefinitionTest.php
PatternsLibraryController.php in modules/ui_patterns_library/src/Controller/PatternsLibraryController.php

... See full list

File

src/Definition/PatternDefinition.php, line 13

Namespace

Drupal\ui_patterns\Definition

View source

class PatternDefinition extends PluginDefinition implements DerivablePluginDefinitionInterface, \ArrayAccess {
  use ArrayAccessDefinitionTrait;

  /**
   * Pattern prefix.
   */
  const PATTERN_PREFIX = 'pattern_';

  /**
   * Prefix for locally defined libraries.
   */
  const LIBRARY_PREFIX = 'ui_patterns';

  /**
   * Pattern definition.
   *
   * @var array
   */
  protected $definition = [
    'id' => NULL,
    'label' => NULL,
    'description' => NULL,
    'base path' => NULL,
    'file name' => NULL,
    'use' => NULL,
    'theme hook' => NULL,
    'custom theme hook' => FALSE,
    'template' => NULL,
    'libraries' => [],
    'fields' => [],
    'variants' => [],
    'tags' => [],
    'additional' => [],
    'deriver' => NULL,
    'provider' => NULL,
    'class' => NULL,
  ];

  /**
   * PatternDefinition constructor.
   */
  public function __construct(array $definition = []) {
    foreach ($definition as $name => $value) {
      if (array_key_exists($name, $this->definition)) {
        $this->definition[$name] = $value;
      }
      else {
        $this->definition['additional'][$name] = $value;
      }
    }
    $this->id = $this->definition['id'];
    $this
      ->setFields($this->definition['fields']);
    $this
      ->setVariants($this->definition['variants']);
    $this
      ->setThemeHook(self::PATTERN_PREFIX . $this
      ->id());
    if (!empty($definition['theme hook'])) {
      $this
        ->setThemeHook($definition['theme hook']);
      $this->definition['custom theme hook'] = TRUE;
    }
    if (!$this
      ->hasTemplate()) {
      $this
        ->setTemplate(str_replace('_', '-', $this
        ->getThemeHook()));
    }
  }

  /**
   * Return array definition.
   *
   * @return array
   *   Array definition.
   */
  public function toArray() {
    $definition = $this->definition;
    foreach ($this
      ->getFields() as $field) {
      $definition['fields'][$field
        ->getName()] = $field
        ->toArray();
    }
    foreach ($this
      ->getVariants() as $variant) {
      $definition['variants'][$variant
        ->getName()] = $variant
        ->toArray();
    }
    return $definition;
  }

  /**
   * Getter.
   *
   * @return mixed
   *   Property value.
   */
  public function getLabel() {
    return $this->definition['label'];
  }

  /**
   * Setter.
   *
   * @param mixed $label
   *   Property value.
   *
   * @return $this
   */
  public function setLabel($label) {
    $this->definition['label'] = $label;
    return $this;
  }

  /**
   * Getter.
   *
   * @return mixed
   *   Property value.
   */
  public function getBasePath() {
    return $this->definition['base path'];
  }

  /**
   * Setter.
   *
   * @param mixed $basePath
   *   Property value.
   *
   * @return $this
   */
  public function setBasePath($basePath) {
    $this->definition['base path'] = $basePath;
    return $this;
  }

  /**
   * Getter.
   *
   * @return mixed
   *   Property value.
   */
  public function getFileName() {
    return $this->definition['file name'];
  }

  /**
   * Setter.
   *
   * @param mixed $fileName
   *   Property value.
   *
   * @return $this
   */
  public function setFileName($fileName) {
    $this->definition['file name'] = $fileName;
    return $this;
  }

  /**
   * Get Provider property.
   *
   * @return string
   *   Property value.
   */
  public function getProvider() {
    return $this->definition['provider'];
  }

  /**
   * Setter.
   *
   * @param mixed $provider
   *   Property value.
   *
   * @return $this
   */
  public function setProvider($provider) {
    $this->definition['provider'] = $provider;
    return $this;
  }

  /**
   * Getter.
   *
   * @return PatternDefinitionField[]
   *   Property value.
   */
  public function getFields() {
    return $this->definition['fields'];
  }

  /**
   * Get field as options.
   *
   * @return array
   *   Fields as select options.
   */
  public function getFieldsAsOptions() {
    $options = [];
    foreach ($this
      ->getFields() as $field) {
      $options[$field
        ->getName()] = $field
        ->getLabel();
    }
    return $options;
  }

  /**
   * Setter.
   *
   * @param array $fields
   *   Property value.
   *
   * @return $this
   */
  public function setFields(array $fields) {
    foreach ($fields as $name => $value) {
      $field = $this
        ->getFieldDefinition($name, $value);
      $this->definition['fields'][$field
        ->getName()] = $field;
    }
    return $this;
  }

  /**
   * Check whereas pattern has variants.
   *
   * @return bool
   *   Whereas pattern has variants.
   */
  public function hasVariants() {
    return !empty($this->definition['variants']);
  }

  /**
   * Getter.
   *
   * @return \Drupal\ui_patterns\Definition\PatternDefinitionVariant[]
   *   Property value.
   */
  public function getVariants() {
    return $this->definition['variants'];
  }

  /**
   * Get field as options.
   *
   * @return array
   *   Variants as select options.
   */
  public function getVariantsAsOptions() {
    $options = [];
    foreach ($this
      ->getVariants() as $field) {
      $options[$field
        ->getName()] = $field
        ->getLabel();
    }
    return $options;
  }

  /**
   * Setter.
   *
   * @param array $variants
   *   Property value.
   *
   * @return $this
   */
  public function setVariants(array $variants) {
    foreach ($variants as $name => $value) {
      $variant = $this
        ->getVariantDefinition($name, $value);
      $this->definition['variants'][$variant
        ->getName()] = $variant;
    }
    return $this;
  }

  /**
   * Get field.
   *
   * @param string $name
   *   Field name.
   *
   * @return PatternDefinitionField|null
   *   Definition field.
   */
  public function getField($name) {
    return $this
      ->hasField($name) ? $this->definition['fields'][$name] : NULL;
  }

  /**
   * Check whereas field exists.
   *
   * @param string $name
   *   Field name.
   *
   * @return bool
   *   Whereas field exists
   */
  public function hasField($name) {
    return isset($this->definition['fields'][$name]);
  }

  /**
   * Set field.
   *
   * @param string $name
   *   Field name.
   * @param string $label
   *   Field label.
   *
   * @return $this
   */
  public function setField($name, $label) {
    $this->definition['fields'][$name] = $this
      ->getFieldDefinition($name, $label);
    return $this;
  }

  /**
   * Get variant.
   *
   * @param string $name
   *   Field name.
   *
   * @return PatternDefinitionField|null
   *   Definition field.
   */
  public function getVariant($name) {
    return $this
      ->hasVariant($name) ? $this->definition['variants'][$name] : NULL;
  }

  /**
   * Check whereas variant exists.
   *
   * @param string $name
   *   Variant name.
   *
   * @return bool
   *   Whereas variant exists
   */
  public function hasVariant($name) {
    return isset($this->definition['variants'][$name]);
  }

  /**
   * Set variant.
   *
   * @param string $name
   *   Variant name.
   * @param string $label
   *   Variant label.
   *
   * @return $this
   */
  public function setVariant($name, $label) {
    $this->definition['variants'][$name] = $this
      ->getVariantDefinition($name, $label);
    return $this;
  }

  /**
   * Getter.
   *
   * @return string
   *   Property value.
   */
  public function getThemeHook() {
    return $this->definition['theme hook'];
  }

  /**
   * Setter.
   *
   * @param string $theme_hook
   *   Property value.
   *
   * @return $this
   */
  public function setThemeHook($theme_hook) {
    $this->definition['theme hook'] = $theme_hook;
    return $this;
  }

  /**
   * Getter.
   *
   * @return string
   *   Property value.
   */
  public function getDescription() {
    return $this->definition['description'];
  }

  /**
   * Setter.
   *
   * @param string $description
   *   Property value.
   *
   * @return $this
   */
  public function setDescription($description) {
    $this->definition['description'] = $description;
    return $this;
  }

  /**
   * Getter.
   *
   * @return bool
   *   Whereas definition uses the "use:" property.
   */
  public function hasUse() {
    return !empty($this->definition['use']);
  }

  /**
   * Getter.
   *
   * @return string
   *   Property value.
   */
  public function getUse() {
    return $this->definition['use'];
  }

  /**
   * Setter.
   *
   * @param string $use
   *   Property value.
   *
   * @return $this
   */
  public function setUse($use) {
    $this->definition['use'] = $use;
    return $this;
  }

  /**
   * Getter.
   *
   * @return array
   *   Property value.
   */
  public function getTags() {
    return $this->definition['tags'];
  }

  /**
   * Setter.
   *
   * @param array $tags
   *   Property value.
   *
   * @return $this
   */
  public function setTags(array $tags) {
    $this->definition['tags'] = $tags;
    return $this;
  }

  /**
   * Getter.
   *
   * @return mixed
   *   Property value.
   */
  public function hasCustomThemeHook() {
    return $this->definition['custom theme hook'];
  }

  /**
   * Getter.
   *
   * @return mixed
   *   Property value.
   */
  public function getTemplate() {
    return $this->definition['template'];
  }

  /**
   * Setter.
   *
   * @param mixed $template
   *   Property value.
   *
   * @return $this
   */
  public function setTemplate($template) {
    $this->definition['template'] = $template;
    return $this;
  }

  /**
   * Getter.
   *
   * @return bool
   *   Whereas has template.
   */
  public function hasTemplate() {
    return !empty($this->definition['template']);
  }

  /**
   * Getter.
   *
   * @return mixed
   *   Property value.
   */
  public function getLibraries() {
    return $this->definition['libraries'];
  }

  /**
   * Getter.
   *
   * @return mixed
   *   Property value.
   */
  public function getLibrariesNames() {
    $libraries = [];
    foreach ($this
      ->getLibraries() as $library) {
      if (is_array($library)) {
        $libraries[] = self::LIBRARY_PREFIX . '/' . $this
          ->id() . '.' . key($library);
      }
      else {
        $libraries[] = $library;
      }
    }
    return $libraries;
  }

  /**
   * Setter.
   *
   * @param mixed $libraries
   *   Property value.
   *
   * @return $this
   */
  public function setLibraries($libraries) {
    $this->definition['libraries'] = $libraries;
    return $this;
  }

  /**
   * Get Deriver property.
   *
   * @return mixed
   *   Property value.
   */
  public function getDeriver() {
    return $this->definition['deriver'];
  }

  /**
   * Get Additional property.
   *
   * @return array
   *   Property value.
   */
  public function getAdditional() {
    return $this->definition['additional'];
  }

  /**
   * Get Class property.
   *
   * @return string
   *   Property value.
   */
  public function getClass() {
    return $this->definition['class'];
  }

  /**
   * Set Class property.
   *
   * @param string $class
   *   Property value.
   *
   * @return $this
   */
  public function setClass($class) {
    parent::setClass($class);
    $this->definition['class'] = $class;
    return $this;
  }

  /**
   * Set Additional property.
   *
   * @param array $additional
   *   Property value.
   *
   * @return $this
   */
  public function setAdditional(array $additional) {
    $this->definition['additional'] = $additional;
    return $this;
  }

  /**
   * Set Deriver property.
   *
   * @param mixed $deriver
   *   Property value.
   *
   * @return $this
   */
  public function setDeriver($deriver) {
    $this->definition['deriver'] = $deriver;
    return $this;
  }

  /**
   * Factory method: create a new field definition.
   *
   * @param string $name
   *   Field name.
   * @param string $value
   *   Field value.
   *
   * @return \Drupal\ui_patterns\Definition\PatternDefinitionField
   *   Definition instance.
   */
  public function getFieldDefinition($name, $value) {
    return new PatternDefinitionField($name, $value);
  }

  /**
   * Factory method: create a new variant definition.
   *
   * @param string $name
   *   Variant name.
   * @param string $value
   *   Variant value.
   *
   * @return \Drupal\ui_patterns\Definition\PatternDefinitionVariant
   *   Definition instance.
   */
  public function getVariantDefinition($name, $value) {
    return new PatternDefinitionVariant($name, $value);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ArrayAccessDefinitionTrait::offsetExists	public	function
ArrayAccessDefinitionTrait::offsetGet	public	function
ArrayAccessDefinitionTrait::offsetSet	public	function
ArrayAccessDefinitionTrait::offsetUnset	public	function
PatternDefinition::$definition	protected	property	Pattern definition.
PatternDefinition::getAdditional	public	function	Get Additional property.
PatternDefinition::getBasePath	public	function	Getter.
PatternDefinition::getClass	public	function	Get Class property. Overrides PluginDefinition::getClass
PatternDefinition::getDeriver	public	function	Get Deriver property. Overrides DerivablePluginDefinitionInterface::getDeriver
PatternDefinition::getDescription	public	function	Getter.
PatternDefinition::getField	public	function	Get field.
PatternDefinition::getFieldDefinition	public	function	Factory method: create a new field definition.
PatternDefinition::getFields	public	function	Getter.
PatternDefinition::getFieldsAsOptions	public	function	Get field as options.
PatternDefinition::getFileName	public	function	Getter.
PatternDefinition::getLabel	public	function	Getter.
PatternDefinition::getLibraries	public	function	Getter.
PatternDefinition::getLibrariesNames	public	function	Getter.
PatternDefinition::getProvider	public	function	Get Provider property. Overrides PluginDefinition::getProvider
PatternDefinition::getTags	public	function	Getter.
PatternDefinition::getTemplate	public	function	Getter.
PatternDefinition::getThemeHook	public	function	Getter.
PatternDefinition::getUse	public	function	Getter.
PatternDefinition::getVariant	public	function	Get variant.
PatternDefinition::getVariantDefinition	public	function	Factory method: create a new variant definition.
PatternDefinition::getVariants	public	function	Getter.
PatternDefinition::getVariantsAsOptions	public	function	Get field as options.
PatternDefinition::hasCustomThemeHook	public	function	Getter.
PatternDefinition::hasField	public	function	Check whereas field exists.
PatternDefinition::hasTemplate	public	function	Getter.
PatternDefinition::hasUse	public	function	Getter.
PatternDefinition::hasVariant	public	function	Check whereas variant exists.
PatternDefinition::hasVariants	public	function	Check whereas pattern has variants.
PatternDefinition::LIBRARY_PREFIX		constant	Prefix for locally defined libraries.
PatternDefinition::PATTERN_PREFIX		constant	Pattern prefix.
PatternDefinition::setAdditional	public	function	Set Additional property.
PatternDefinition::setBasePath	public	function	Setter.
PatternDefinition::setClass	public	function	Set Class property. Overrides PluginDefinition::setClass
PatternDefinition::setDeriver	public	function	Set Deriver property. Overrides DerivablePluginDefinitionInterface::setDeriver
PatternDefinition::setDescription	public	function	Setter.
PatternDefinition::setField	public	function	Set field.
PatternDefinition::setFields	public	function	Setter.
PatternDefinition::setFileName	public	function	Setter.
PatternDefinition::setLabel	public	function	Setter.
PatternDefinition::setLibraries	public	function	Setter.
PatternDefinition::setProvider	public	function	Setter.
PatternDefinition::setTags	public	function	Setter.
PatternDefinition::setTemplate	public	function	Setter.
PatternDefinition::setThemeHook	public	function	Setter.
PatternDefinition::setUse	public	function	Setter.
PatternDefinition::setVariant	public	function	Set variant.
PatternDefinition::setVariants	public	function	Setter.
PatternDefinition::toArray	public	function	Return array definition.
PatternDefinition::__construct	public	function	PatternDefinition 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::id	public	function	Gets the unique identifier of the plugin. Overrides PluginDefinitionInterface::id	1

You are here

class PatternDefinition in UI Patterns 8

Hierarchy

File

Namespace

Members

API Navigation