PHP Class phprs\util\DocParser

It is strongly discouraged to change the default annotation parsing process.
Author: Benjamin Eberlei ([email protected])
Author: Guilherme Blanco ([email protected])
Author: Jonathan Wage ([email protected])
Author: Roman Borschel ([email protected])
Author: Johannes M. Schmitt ([email protected])
Author: Fabio B. Silva ([email protected])
Datei anzeigen Open project: caoym/phprs-restful

Public Methods

Method Description
__construct ( ) Constructs a new DocParser.
parse ( string $input, string $context = '', $record_doc ) : array Parses the given docblock string for annotations.
setIgnoredAnnotationNames ( array $names ) : void Sets the annotation names that are ignored during the parsing process.

Private Methods

Method Description
Annotations ( $record_doc = false ) : 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}* [","]
findInitialTokenPosition ( string $input ) : integer | null Finds the first valid annotation
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

__construct() public method

Constructs a new DocParser.
public __construct ( )

parse() public method

Parses the given docblock string for annotations.
public parse ( string $input, string $context = '', $record_doc ) : array
$input string The docblock string to parse.
$context string The parsing context.
return array Array of annotations. If no annotations are found, an empty array is returned.

setIgnoredAnnotationNames() public method

The names are supposed to be the raw names as used in the class, not the fully qualified class names.
public setIgnoredAnnotationNames ( array $names ) : void
$names array
return void