final class Enum in Zircon Profile 8

Annotation that can be used to signal to the parser to check the available values during the parsing process.

@since 2.4 @author Fabio B. Silva <[e-mail]>

Plugin annotation

@Attributes({
   @Attribute("value",   required = true,  type = "array"),
   @Attribute("literal", required = false, type = "array")
})

Hierarchy

• class \Doctrine\Common\Annotations\Annotation\Enum

Related topics

Annotations

Annotations for class discovery and metadata description.

1 file declares its use of Enum

DocParser.php in vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/DocParser.php

File

vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/Annotation/Enum.php, line 36

Namespace

Doctrine\Common\Annotations\Annotation

final class Enum {

  /**
   * @var array
   */
  public $value;

  /**
   * Literal target declaration.
   *
   * @var array
   */
  public $literal;

  /**
   * Annotation constructor.
   *
   * @param array $values
   *
   * @throws \InvalidArgumentException
   */
  public function __construct(array $values) {
    if (!isset($values['literal'])) {
      $values['literal'] = array();
    }
    foreach ($values['value'] as $var) {
      if (!is_scalar($var)) {
        throw new \InvalidArgumentException(sprintf('@Enum supports only scalar values "%s" given.', is_object($var) ? get_class($var) : gettype($var)));
      }
    }
    foreach ($values['literal'] as $key => $var) {
      if (!in_array($key, $values['value'])) {
        throw new \InvalidArgumentException(sprintf('Undefined enumerator value "%s" for literal "%s".', $key, $var));
      }
    }
    $this->value = $values['value'];
    $this->literal = $values['literal'];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Enum::$literal	public	property	Literal target declaration.
Enum::$value	public	property
Enum::__construct	public	function	Annotation constructor.