class PatternDefinitionVariant in UI Patterns 8

Class PatternDefinitionVariant.

@package Drupal\ui_patterns\Definition

Hierarchy

• class \Drupal\ui_patterns\Definition\PatternDefinitionVariant implements \Drupal\ui_patterns\Definition\ArrayAccess uses ArrayAccessDefinitionTrait

File

src/Definition/PatternDefinitionVariant.php, line 10

Namespace

Drupal\ui_patterns\Definition

class PatternDefinitionVariant implements \ArrayAccess {
  use ArrayAccessDefinitionTrait;

  /**
   * Default field values.
   *
   * @var array
   */
  protected $definition = [
    'name' => NULL,
    'label' => NULL,
    'description' => NULL,
  ];

  /**
   * PatternDefinitionVariant constructor.
   */
  public function __construct($name, $value) {
    if (is_scalar($value)) {
      $this->definition['name'] = is_numeric($name) ? $value : $name;
      $this->definition['label'] = $value;
    }
    else {
      $this->definition['name'] = !isset($value['name']) ? $name : $value['name'];
      $this->definition['label'] = $value['label'];
      $this->definition = $value + $this->definition;
    }
  }

  /**
   * Return array definition.
   *
   * @return array
   *   Array definition.
   */
  public function toArray() {
    return $this->definition;
  }

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

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

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

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

}

Members

Name	Modifiers	Type	Description	Overrides
ArrayAccessDefinitionTrait::offsetExists	public	function
ArrayAccessDefinitionTrait::offsetGet	public	function
ArrayAccessDefinitionTrait::offsetSet	public	function
ArrayAccessDefinitionTrait::offsetUnset	public	function
PatternDefinitionVariant::$definition	protected	property	Default field values.
PatternDefinitionVariant::getDescription	public	function	Get Description property.
PatternDefinitionVariant::getLabel	public	function	Get Label property.
PatternDefinitionVariant::getName	public	function	Get Name property.
PatternDefinitionVariant::setDescription	public	function	Set Description property.
PatternDefinitionVariant::toArray	public	function	Return array definition.
PatternDefinitionVariant::__construct	public	function	PatternDefinitionVariant constructor.