Documentation

SimpleAnnotationReader
in package
implements Reader

Simple Annotation Reader.

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

Tags
deprecated

Deprecated in favour of using AnnotationReader

Interfaces, Classes and Traits

Reader
Interface for annotation readers.

Table of Contents

$parser  : DocParser
__construct()  : mixed
Initializes a new SimpleAnnotationReader.
addNamespace()  : void
Adds a namespace in which we will look for annotations.
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

Methods

__construct()

Initializes a new SimpleAnnotationReader.

public __construct() : mixed
Return values
mixed

addNamespace()

Adds a namespace in which we will look for annotations.

public addNamespace(string $namespace) : void
Parameters
$namespace : string
Return values
void

getClassAnnotation()

Gets a class annotation.

public getClassAnnotation(ReflectionClass $class, mixed $annotationName) : T|null
Parameters
$class : ReflectionClass

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

$annotationName : mixed

The name of the annotation.

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 $annotationName) : T|null
Parameters
$method : ReflectionMethod

The ReflectionMethod to read the annotations from.

$annotationName : mixed

The name of the annotation.

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 $annotationName) : T|null
Parameters
$property : ReflectionProperty

The ReflectionProperty to read the annotations from.

$annotationName : mixed

The name of the annotation.

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.

Search results