IndexedReader
in package
implements
Reader
Allows the reader to be used in-place of Doctrine's reader.
Interfaces, Classes and Traits
- Reader
- Interface for annotation readers.
Table of Contents
- $delegate : Reader
- __call() : mixed
- Proxies all methods to the delegate.
- __construct() : mixed
- getClassAnnotation() : T|null
- Gets a class annotation.
- getClassAnnotations() : array<string|int, object>
- Gets the annotations applied to a class.
- getMethodAnnotation() : T|null
- Gets a method annotation.
- getMethodAnnotations() : array<string|int, object>
- Gets the annotations applied to a method.
- getPropertyAnnotation() : T|null
- Gets a property annotation.
- getPropertyAnnotations() : array<string|int, object>
- Gets the annotations applied to a property.
Properties
$delegate
private
Reader
$delegate
Methods
__call()
Proxies all methods to the delegate.
public
__call(string $method, array<string|int, mixed> $args) : mixed
Parameters
- $method : string
- $args : array<string|int, mixed>
Return values
mixed —__construct()
public
__construct(Reader $reader) : mixed
Parameters
- $reader : Reader
Return values
mixed —getClassAnnotation()
Gets a class annotation.
public
getClassAnnotation(ReflectionClass $class, mixed $annotation) : T|null
Parameters
- $class : ReflectionClass
-
The ReflectionClass of the class from which the class annotations should be read.
- $annotation : mixed
Return values
T|null —The Annotation or NULL, if the requested annotation does not exist.
getClassAnnotations()
Gets the annotations applied to a class.
public
getClassAnnotations(ReflectionClass $class) : array<string|int, object>
Parameters
- $class : ReflectionClass
-
The ReflectionClass of the class from which the class annotations should be read.
Return values
array<string|int, object> —An array of Annotations.
getMethodAnnotation()
Gets a method annotation.
public
getMethodAnnotation(ReflectionMethod $method, mixed $annotation) : T|null
Parameters
- $method : ReflectionMethod
-
The ReflectionMethod to read the annotations from.
- $annotation : mixed
Return values
T|null —The Annotation or NULL, if the requested annotation does not exist.
getMethodAnnotations()
Gets the annotations applied to a method.
public
getMethodAnnotations(ReflectionMethod $method) : array<string|int, object>
Parameters
- $method : ReflectionMethod
-
The ReflectionMethod of the method from which the annotations should be read.
Return values
array<string|int, object> —An array of Annotations.
getPropertyAnnotation()
Gets a property annotation.
public
getPropertyAnnotation(ReflectionProperty $property, mixed $annotation) : T|null
Parameters
- $property : ReflectionProperty
-
The ReflectionProperty to read the annotations from.
- $annotation : mixed
Return values
T|null —The Annotation or NULL, if the requested annotation does not exist.
getPropertyAnnotations()
Gets the annotations applied to a property.
public
getPropertyAnnotations(ReflectionProperty $property) : array<string|int, object>
Parameters
- $property : ReflectionProperty
-
The ReflectionProperty of the property from which the annotations should be read.
Return values
array<string|int, object> —An array of Annotations.