Doctrine\Common\Annotations\AnnotationReader
A reader for docblock annotations.
- Author: Benjamin Eberlei <kontakt@beberlei.de>
Synopsis
class AnnotationReader
implements
Reader
{
- // members
- private array $globalImports;
- private array $globalIgnoredNames;
- private DocParser $parser;
- private DocParser $preParser;
- private PhpParser $phpParser;
- private array $imports;
- private array $ignoredAnnotationNames;
- // methods
- public static void addGlobalIgnoredName()
- public void __construct()
- public array getClassAnnotations()
- public mixed getClassAnnotation()
- public array getPropertyAnnotations()
- public mixed getPropertyAnnotation()
- public array getMethodAnnotations()
- public mixed getMethodAnnotation()
- private array getIgnoredAnnotationNames()
- private array getImports()
- private void collectParsingMetadata()
Hierarchy
Implements
Members
private
- $globalIgnoredNames
—
array
A list with annotations that are not causing exceptions when not resolved to an annotation class. - $globalImports
—
array
Global map for imports. - $ignoredAnnotationNames
—
array
In-memory cache mechanism to store ignored annotations per class. - $imports
—
array
In-memory cache mechanism to store imported annotations per class. - $parser
—
\Doctrine\Common\Annotations\DocParser
Annotations Parser - $phpParser
—
\Doctrine\Common\Annotations\PhpParser
PHP Parser used to collect imports. - $preParser
—
\Doctrine\Common\Annotations\DocParser
Annotations Parser used to collect parsing metadata
Methods
private
- collectParsingMetadata() — Collects parsing metadata for a given class
- getIgnoredAnnotationNames() — Returns the ignored annotations for the given class.
- getImports() — Retrieve imports
public
- __construct() — Constructor.
- addGlobalIgnoredName() — Add a new annotation to the globally ignored annotation names with regard to exception handling.
- getClassAnnotation() — Gets a class annotation.
- getClassAnnotations() — Gets the annotations applied to a class.
- getMethodAnnotation() — Gets a method annotation.
- getMethodAnnotations() — Gets the annotations applied to a method.
- getPropertyAnnotation() — Gets a property annotation.
- getPropertyAnnotations() — Gets the annotations applied to a property.