final class IgnoreAnnotation

Annotation that can be used to signal to the parser to ignore specific annotations during the parsing process.

@author Johannes M. Schmitt <schmittjoh@gmail.com>

Hierarchy

Expanded class hierarchy of IgnoreAnnotation

3 files declare their use of IgnoreAnnotation
AbstractReaderTest.php in drupal/core/vendor/doctrine/common/tests/Doctrine/Tests/Common/Annotations/AbstractReaderTest.php
AnnotationReader.php in drupal/core/vendor/doctrine/common/lib/Doctrine/Common/Annotations/AnnotationReader.php
DocParserTest.php in drupal/core/vendor/doctrine/common/tests/Doctrine/Tests/Common/Annotations/DocParserTest.php
1 class is annotated with IgnoreAnnotation
InvalidAnnotationUsageButIgnoredClass in drupal/core/vendor/doctrine/common/tests/Doctrine/Tests/Common/Annotations/Fixtures/InvalidAnnotationUsageButIgnoredClass.php
@NoAnnotation

File

drupal/core/vendor/doctrine/common/lib/Doctrine/Common/Annotations/Annotation/IgnoreAnnotation.php, line 29

Namespace

Doctrine\Common\Annotations\Annotation
View source
final class IgnoreAnnotation {

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

  /**
   * Constructor
   *
   * @param array $values
   *
   * @throws \RuntimeException
   */
  public function __construct(array $values) {
    if (is_string($values['value'])) {
      $values['value'] = array(
        $values['value'],
      );
    }
    if (!is_array($values['value'])) {
      throw new \RuntimeException(sprintf('@IgnoreAnnotation expects either a string name, or an array of strings, but got %s.', json_encode($values['value'])));
    }
    $this->names = $values['value'];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
IgnoreAnnotation::$names public property
IgnoreAnnotation::__construct public function Constructor