class SimpleAnnotationReader in Zircon Profile 8

Simple Annotation Reader.

This annotation reader is intended to be used in projects where you have full-control over all annotations that are available.

@since 2.2 @author Johannes M. Schmitt <[e-mail]> @author Fabio B. Silva <[e-mail]>

Hierarchy

• class \Doctrine\Common\Annotations\SimpleAnnotationReader implements Reader

2 files declare their use of SimpleAnnotationReader

AnnotatedClassDiscovery.php in core/lib/Drupal/Component/Annotation/Plugin/Discovery/AnnotatedClassDiscovery.php

Contains \Drupal\Component\Annotation\Plugin\Discovery\AnnotatedClassDiscovery.

TestDiscovery.php in core/modules/simpletest/src/TestDiscovery.php

Contains \Drupal\simpletest\TestDiscovery.

File

vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/SimpleAnnotationReader.php, line 32

Namespace

Doctrine\Common\Annotations

class SimpleAnnotationReader implements Reader {

  /**
   * @var DocParser
   */
  private $parser;

  /**
   * Constructor.
   *
   * Initializes a new SimpleAnnotationReader.
   */
  public function __construct() {
    $this->parser = new DocParser();
    $this->parser
      ->setIgnoreNotImportedAnnotations(true);
  }

  /**
   * Adds a namespace in which we will look for annotations.
   *
   * @param string $namespace
   *
   * @return void
   */
  public function addNamespace($namespace) {
    $this->parser
      ->addNamespace($namespace);
  }

  /**
   * {@inheritDoc}
   */
  public function getClassAnnotations(\ReflectionClass $class) {
    return $this->parser
      ->parse($class
      ->getDocComment(), 'class ' . $class
      ->getName());
  }

  /**
   * {@inheritDoc}
   */
  public function getMethodAnnotations(\ReflectionMethod $method) {
    return $this->parser
      ->parse($method
      ->getDocComment(), 'method ' . $method
      ->getDeclaringClass()->name . '::' . $method
      ->getName() . '()');
  }

  /**
   * {@inheritDoc}
   */
  public function getPropertyAnnotations(\ReflectionProperty $property) {
    return $this->parser
      ->parse($property
      ->getDocComment(), 'property ' . $property
      ->getDeclaringClass()->name . '::$' . $property
      ->getName());
  }

  /**
   * {@inheritDoc}
   */
  public function getClassAnnotation(\ReflectionClass $class, $annotationName) {
    foreach ($this
      ->getClassAnnotations($class) as $annot) {
      if ($annot instanceof $annotationName) {
        return $annot;
      }
    }
    return null;
  }

  /**
   * {@inheritDoc}
   */
  public function getMethodAnnotation(\ReflectionMethod $method, $annotationName) {
    foreach ($this
      ->getMethodAnnotations($method) as $annot) {
      if ($annot instanceof $annotationName) {
        return $annot;
      }
    }
    return null;
  }

  /**
   * {@inheritDoc}
   */
  public function getPropertyAnnotation(\ReflectionProperty $property, $annotationName) {
    foreach ($this
      ->getPropertyAnnotations($property) as $annot) {
      if ($annot instanceof $annotationName) {
        return $annot;
      }
    }
    return null;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SimpleAnnotationReader::$parser	private	property
SimpleAnnotationReader::addNamespace	public	function	Adds a namespace in which we will look for annotations.
SimpleAnnotationReader::getClassAnnotation	public	function	Gets a class annotation. Overrides Reader::getClassAnnotation
SimpleAnnotationReader::getClassAnnotations	public	function	Gets the annotations applied to a class. Overrides Reader::getClassAnnotations
SimpleAnnotationReader::getMethodAnnotation	public	function	Gets a method annotation. Overrides Reader::getMethodAnnotation
SimpleAnnotationReader::getMethodAnnotations	public	function	Gets the annotations applied to a method. Overrides Reader::getMethodAnnotations
SimpleAnnotationReader::getPropertyAnnotation	public	function	Gets a property annotation. Overrides Reader::getPropertyAnnotation
SimpleAnnotationReader::getPropertyAnnotations	public	function	Gets the annotations applied to a property. Overrides Reader::getPropertyAnnotations
SimpleAnnotationReader::__construct	public	function	Constructor.