SimpleAnnotationReader.php

<?php

/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */
namespace Doctrine\Common\Annotations;

use Doctrine\Common\Annotations\Annotation\Target;

/**
 * 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 <schmittjoh@gmail.com>
 * @author Fabio B. Silva <fabio.bat.silva@gmail.com>
 */
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
   */
  public function addNamespace($namespace) {
    $this->parser
      ->addNamespace($namespace);
  }

  /**
   * Gets the annotations applied to a class.
   *
   * @param \ReflectionClass $class The ReflectionClass of the class from which
   *                               the class annotations should be read.
   *
   * @return array An array of Annotations.
   */
  public function getClassAnnotations(\ReflectionClass $class) {
    return $this->parser
      ->parse($class
      ->getDocComment(), 'class ' . $class
      ->getName());
  }

  /**
   * Gets the annotations applied to a method.
   *
   * @param \ReflectionMethod $method The ReflectionMethod of the method from which
   *                                   the annotations should be read.
   *
   * @return array An array of Annotations.
   */
  public function getMethodAnnotations(\ReflectionMethod $method) {
    return $this->parser
      ->parse($method
      ->getDocComment(), 'method ' . $method
      ->getDeclaringClass()->name . '::' . $method
      ->getName() . '()');
  }

  /**
   * Gets the annotations applied to a property.
   *
   * @param \ReflectionProperty $property The ReflectionProperty of the property
   *                                     from which the annotations should be read.
   *
   * @return array An array of Annotations.
   */
  public function getPropertyAnnotations(\ReflectionProperty $property) {
    return $this->parser
      ->parse($property
      ->getDocComment(), 'property ' . $property
      ->getDeclaringClass()->name . '::$' . $property
      ->getName());
  }

  /**
   * Gets a class annotation.
   *
   * @param \ReflectionClass $class The ReflectionClass of the class from which
   *                               the class annotations should be read.
   * @param string $annotationName The name of the annotation.
   *
   * @return mixed The Annotation or NULL, if the requested annotation does not exist.
   */
  public function getClassAnnotation(\ReflectionClass $class, $annotationName) {
    foreach ($this
      ->getClassAnnotations($class) as $annot) {
      if ($annot instanceof $annotationName) {
        return $annot;
      }
    }
    return null;
  }

  /**
   * Gets a method annotation.
   *
   * @param \ReflectionMethod $method
   * @param string $annotationName The name of the annotation.
   *
   * @return mixed The Annotation or NULL, if the requested annotation does not exist.
   */
  public function getMethodAnnotation(\ReflectionMethod $method, $annotationName) {
    foreach ($this
      ->getMethodAnnotations($method) as $annot) {
      if ($annot instanceof $annotationName) {
        return $annot;
      }
    }
    return null;
  }

  /**
   * Gets a property annotation.
   *
   * @param \ReflectionProperty $property
   * @param string $annotationName The name of the annotation.
   * @return mixed The Annotation or NULL, if the requested annotation does not exist.
   */
  public function getPropertyAnnotation(\ReflectionProperty $property, $annotationName) {
    foreach ($this
      ->getPropertyAnnotations($property) as $annot) {
      if ($annot instanceof $annotationName) {
        return $annot;
      }
    }
    return null;
  }

}