1. class
  2. Doctrine
  3. \
  4. Common
  5. \
  6. Annotations
  7. \
  8. AnnotationReader

AnnotationReader

class AnnotationReader implements Reader (View source)

A reader for docblock annotations.

Methods

static 
addGlobalIgnoredName(string $name)

Add a new annotation to the globally ignored annotation names with regard to exception handling.

static 
addGlobalIgnoredNamespace(string $namespace)

Add a new annotation to the globally ignored annotation namespaces with regard to exception handling.

__construct(DocParser $parser = null)

Constructor.

array
getClassAnnotations(ReflectionClass $class)

Gets the annotations applied to a class.

object|null
getClassAnnotation(ReflectionClass $class, string $annotationName)

Gets a class annotation.

array
getPropertyAnnotations(ReflectionProperty $property)

Gets the annotations applied to a property.

object|null
getPropertyAnnotation(ReflectionProperty $property, string $annotationName)

Gets a property annotation.

array
getMethodAnnotations(ReflectionMethod $method)

Gets the annotations applied to a method.

object|null
getMethodAnnotation(ReflectionMethod $method, string $annotationName)

Gets a method annotation.

Details

at line 119
static addGlobalIgnoredName(string $name)

Add a new annotation to the globally ignored annotation names with regard to exception handling.

Parameters

string $name

at line 129
static addGlobalIgnoredNamespace(string $namespace)

Add a new annotation to the globally ignored annotation namespaces with regard to exception handling.

Parameters

string $namespace

at line 178
__construct(DocParser $parser = null)

Constructor.

Initializes a new AnnotationReader.

Parameters

DocParser $parser

Exceptions

AnnotationException

at line 213
array getClassAnnotations(ReflectionClass $class)

Gets the annotations applied to a class.

Parameters

ReflectionClass $class The ReflectionClass of the class from which the class annotations should be read.

Return Value

array An array of Annotations.

at line 226
object|null getClassAnnotation(ReflectionClass $class, string $annotationName)

Gets a class annotation.

Parameters

ReflectionClass $class The ReflectionClass of the class from which the class annotations should be read.
string $annotationName The name of the annotation.

Return Value

object|null The Annotation or NULL, if the requested annotation does not exist.

at line 242
array getPropertyAnnotations(ReflectionProperty $property)

Gets the annotations applied to a property.

Parameters

ReflectionProperty $property The ReflectionProperty of the property from which the annotations should be read.

Return Value

array An array of Annotations.

at line 258
object|null getPropertyAnnotation(ReflectionProperty $property, string $annotationName)

Gets a property annotation.

Parameters

ReflectionProperty $property The ReflectionProperty to read the annotations from.
string $annotationName The name of the annotation.

Return Value

object|null The Annotation or NULL, if the requested annotation does not exist.

at line 274
array getMethodAnnotations(ReflectionMethod $method)

Gets the annotations applied to a method.

Parameters

ReflectionMethod $method The ReflectionMethod of the method from which the annotations should be read.

Return Value

array An array of Annotations.

at line 290
object|null getMethodAnnotation(ReflectionMethod $method, string $annotationName)

Gets a method annotation.

Parameters

ReflectionMethod $method The ReflectionMethod to read the annotations from.
string $annotationName The name of the annotation.

Return Value

object|null The Annotation or NULL, if the requested annotation does not exist.