Zend Framework
3.0
|
A parser for docblock annotations that utilizes the annotation parser from Doctrine. More...
Public Member Functions | |
__construct () | |
setDocParser (DocParser $docParser) | |
Set the DocParser instance. | |
getDocParser () | |
Retrieve the DocParser instance. | |
onCreateAnnotation (EventInterface $e) | |
Handle annotation creation. | |
registerAnnotation ($annotation) | |
Specify an allowed annotation class. | |
registerAnnotations ($annotations) | |
Set many allowed annotations at once. | |
Protected Attributes | |
$allowedAnnotations = [] | |
$docParser | |
A parser for docblock annotations that utilizes the annotation parser from Doctrine.
Consumes Doctrine, and responds to events from AnnotationManager. If the annotation examined is in the list of classes we are interested in, the raw annotation is passed to the DocParser in order to retrieve the annotation object instance. Otherwise, it is skipped.
__construct | ( | ) |
getDocParser | ( | ) |
Retrieve the DocParser instance.
If none is registered, lazy-loads a new instance.
onCreateAnnotation | ( | EventInterface | $e | ) |
registerAnnotation | ( | $annotation | ) |
Specify an allowed annotation class.
string | $annotation |
Implements ParserInterface.
registerAnnotations | ( | $annotations | ) |
Set many allowed annotations at once.
array | Traversable | $annotations | Array or traversable object of annotation class names |
Exception\InvalidArgumentException |
Implements ParserInterface.
setDocParser | ( | DocParser | $docParser | ) |
|
protected |
|
protected |