• Home
• Doctrine
• Common
• Annotations
• DocParser

PHP Class Doctrine\Common\Annotations\DocParser

It is strongly discouraged to change the default annotation parsing process. Datei anzeigen Open project: doctrine/annotations Class Usage Examples

Public Methods

Method	Description
__construct ( )	Constructs a new DocParser.
addNamespace ( array $namespace ) : void	Sets the default namespaces.
parse ( string $input, string $context = '' ) : array	Parses the given docblock string for annotations.
setIgnoreNotImportedAnnotations ( boolean $bool ) : void	Sets ignore on not-imported annotations.
setIgnoredAnnotationNames ( array $names ) : void	Sets the annotation names that are ignored during the parsing process.
setIgnoredAnnotationNamespaces ( bool[] $ignoredAnnotationNamespaces ) : void	Sets the annotation namespaces that are ignored during the parsing process.
setImports ( array $imports ) : void	Sets the imports.
setTarget ( integer $target ) : void	Sets current target context as bitmask.

Private Methods

Method	Description
Annotation ( ) : mixed	Annotation ::= "@" AnnotationName MethodCall AnnotationName ::= QualifiedName | SimpleName QualifiedName ::= NameSpacePart "\" {NameSpacePart "\"}* SimpleName NameSpacePart ::= identifier | null | false | true SimpleName ::= identifier | null | false | true
Annotations ( ) : array	Annotations ::= Annotation {[ "*" ]* [Annotation]}*
ArrayEntry ( ) : array	ArrayEntry ::= Value | KeyValuePair KeyValuePair ::= Key ("=" | ":") PlainValue | Constant Key ::= string | integer | Constant
Arrayx ( ) : array	Array ::= "{" ArrayEntry {"," ArrayEntry}* [","] "}"
Constant ( ) : mixed	Constant ::= integer | string | float | boolean
FieldAssignment ( ) : array	FieldAssignment ::= FieldName "=" PlainValue FieldName ::= identifier
Identifier ( ) : string	Identifier ::= string
MethodCall ( ) : array	MethodCall ::= ["(" [Values] ")"]
PlainValue ( ) : mixed	PlainValue ::= integer | string | float | boolean | Array | Annotation
Value ( ) : mixed	Value ::= PlainValue | FieldAssignment
Values ( ) : array	Values ::= Array | Value {"," Value}* [","]
classExists ( string $fqcn ) : boolean	Attempts to check if a class exists or not. This never goes through the PHP autoloading mechanism but uses the {@link AnnotationRegistry} to load classes.
collectAnnotationMetadata ( string $name ) : void	Collects parsing metadata for a given annotation class
collectAttributeTypeMetadata ( array &$metadata, Doctrine\Common\Annotations\Annotation\Attribute $attribute ) : void	Collects parsing metadata for a given attribute.
findInitialTokenPosition ( string $input ) : integer | null	Finds the first valid annotation
isIgnoredAnnotation ( string $name ) : boolean	Checks whether the given $name matches any ignored annotation name or namespace
match ( integer $token ) : boolean	Attempts to match the given token with the current lookahead token.
matchAny ( array $tokens ) : boolean	Attempts to match the current lookahead token with any of the given tokens.
syntaxError ( string $expected, array | null $token = null ) : void	Generates a new syntax error.

Method Details