interface Reader in Service Container 7.2

Interface for annotation readers.

@author Johannes M. Schmitt <[e-mail]>

Hierarchy

• interface \Doctrine\Common\Annotations\Reader

File

modules/providers/service_container_annotation_discovery/lib/Doctrine/annotations/lib/Doctrine/Common/Annotations/Reader.php, line 27

Namespace

Doctrine\Common\Annotations

interface Reader {

  /**
   * 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.
   */
  function getClassAnnotations(\ReflectionClass $class);

  /**
   * 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 object|null The Annotation or NULL, if the requested annotation does not exist.
   */
  function getClassAnnotation(\ReflectionClass $class, $annotationName);

  /**
   * 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.
   */
  function getMethodAnnotations(\ReflectionMethod $method);

  /**
   * Gets a method annotation.
   *
   * @param \ReflectionMethod $method         The ReflectionMethod to read the annotations from.
   * @param string            $annotationName The name of the annotation.
   *
   * @return object|null The Annotation or NULL, if the requested annotation does not exist.
   */
  function getMethodAnnotation(\ReflectionMethod $method, $annotationName);

  /**
   * 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.
   */
  function getPropertyAnnotations(\ReflectionProperty $property);

  /**
   * Gets a property annotation.
   *
   * @param \ReflectionProperty $property       The ReflectionProperty to read the annotations from.
   * @param string              $annotationName The name of the annotation.
   *
   * @return object|null The Annotation or NULL, if the requested annotation does not exist.
   */
  function getPropertyAnnotation(\ReflectionProperty $property, $annotationName);

}

Members

Name	Modifiers	Type	Description	Overrides
Reader::getClassAnnotation		function	Gets a class annotation.	5
Reader::getClassAnnotations		function	Gets the annotations applied to a class.	5
Reader::getMethodAnnotation		function	Gets a method annotation.	5
Reader::getMethodAnnotations		function	Gets the annotations applied to a method.	5
Reader::getPropertyAnnotation		function	Gets a property annotation.	5
Reader::getPropertyAnnotations		function	Gets the annotations applied to a property.	5