+ The PHP Parser class that build the AST tree from the lexer
+Type: Parser
+Parameters
+
+Properties
+
+lexer Lexer current lexer instanceast AST the AST factory instancetoken (Integer | String) current tokenextractDoc Boolean should extract documentation as AST nodeextractTokens Boolean should extract each tokensuppressErrors Boolean should ignore parsing errors and continuedebug Boolean should output debug informations
+getTokenName
+helper : gets a token name
+Parameters
+
+parse
+main entry point : converts a source code to AST
+Parameters
+
+raiseError
+Raise an error
+Parameters
+
+messagemsgExpectexpecttoken
+error
+handling errors
+Parameters
+
+node
+Creates a new AST node
+Parameters
+
+expectEndOfStatement
+expects an end of statement or end of file
+Returns boolean
+expect
+Force the parser to check the current token.
+If the current token does not match to expected token,
+the an error will be raised.
+If the suppressError mode is activated, then the error will
+be added to the program error stack and this function will return false.
+Parameters
+
+
+Returns boolean
+text
+Returns the current token contents
+Returns String
+next
+consume the next token *
+lex
+Eating a token
+is
+Check if token is of specified type
+Parameters
+
+ignoreStack
+outputs some debug information on current token *
+read_array
+Parse an array
+array ::= T_ARRAY '(' array_pair_list ')' |
+ '[' array_pair_list ']'
+
+read_array_pair_list
+Reads an array entry item
+array_pair_list ::= '&' w_variable |
+ (
+ expr (
+ T_DOUBLE_ARROW (
+ expr | '&' w_variable
+ )
+ )?
+ )
+
+read_dim_offset
+ dim_offset ::= expr?
+
+read_class
+reading a class
+class ::= class_scope? T_CLASS T_STRING (T_EXTENDS NAMESPACE_NAME)? (T_IMPLEMENTS (NAMESPACE_NAME ',')* NAMESPACE_NAME)? '{' CLASS_BODY '}'
+
+read_class_scope
+Read the class visibility
+ class_scope ::= (T_FINAL | T_ABSTRACT)?
+
+read_class_body
+Reads a class body
+ class_body ::= (member_flags? (T_VAR | T_STRING | T_FUNCTION))*
+
+read_variable_list
+Reads variable list
+ variable_list ::= (variable_declaration ',')* variable_declaration
+
+read_constant_list
+Reads constant list
+ constant_list ::= T_CONST (constant_declaration ',')* constant_declaration
+
+read_member_flags
+Read member flags
+Returns any array
+1st index : 0 => public, 1 => protected, 2 => private
+2nd index : 0 => instance member, 1 => static member
+3rd index : 0 => normal, 1 => abstract member, 2 => final member
+read_interface
+reading an interface
+interface ::= T_INTERFACE T_STRING (T_EXTENDS (NAMESPACE_NAME ',')* NAMESPACE_NAME)? '{' INTERFACE_BODY '}'
+
+read_interface_body
+Reads an interface body
+ interface_body ::= (member_flags? (T_CONST | T_FUNCTION))*
+
+read_trait
+reading a trait
+trait ::= T_TRAIT T_STRING (T_EXTENDS (NAMESPACE_NAME ',')* NAMESPACE_NAME)? '{' FUNCTION* '}'
+
+read_trait_use_statement
+reading a use statement
+trait_use_statement ::= namespace_name (',' namespace_name)* ('{' trait_use_alias '}')?
+
+read_trait_use_alias
+Reading trait alias
+trait_use_alias ::= namespace_name ( T_DOUBLE_COLON T_STRING )? (T_INSTEADOF namespace_name) | (T_AS member_flags? T_STRING)
+
+name list : https://github.com/php/php-src/blob/master/Zend/zend_language_parser.y#L303
+trait adaptation : https://github.com/php/php-src/blob/master/Zend/zend_language_parser.y#L742
+read_variable_declaration
+Reads a variable declaration
+ variable_declaration ::= T_VARIABLE '=' scalar
+
+read_constant_declaration
+Reads a constant declaration
+ constant_declaration ::= (T_STRING | IDENTIFIER) '=' expr
+
+Returns Constant :link:
+
+Comments with // or # or / _ ... _ /
+
+Comments with / *_ ... _ /
+read_expr_item
+Reads an expression
+ expr ::= @todo
+
+read_new_expr
+ new_expr ::= T_NEW (namespace_name function_argument_list) | (T_CLASS ... class declaration)
+
+https://github.com/php/php-src/blob/master/Zend/zend_language_parser.y#L850
+read_class_name_reference
+Reads a class name
+class_name_reference ::= namespace_name | variable
+
+read_assignment_list
+ assignment_list ::= assignment_list_element (',' assignment_list_element?)*
+
+read_assignment_list_element
+ assignment_list_element ::= expr | expr T_DOUBLE_ARROW expr
+
+is_reference
+checks if current token is a reference keyword
+is_variadic
+checks if current token is a variadic keyword
+read_function
+reading a function
+function ::= function_declaration code_block
+
+read_function_declaration
+reads a function declaration (without his body)
+function_declaration ::= T_FUNCTION '&'? T_STRING '(' parameter_list ')'
+
+read_lexical_var
+lexical_var ::= '&'? T_VARIABLE
+
+read_parameter_list
+reads a list of parameters
+ parameter_list ::= (parameter ',')* parameter?
+
+read_parameter
+ parameter ::= type? '&'? T_ELLIPSIS? T_VARIABLE ('=' expr)?
+
+read_function_argument_list
+Reads a list of arguments
+ function_argument_list ::= '(' (argument_list (',' argument_list)*)? ')'
+
+read_argument_list
+ argument_list ::= T_ELLIPSIS? expr
+
+read_type
+read type hinting
+ type ::= T_ARRAY | T_CALLABLE | namespace_name
+
+read_if
+Reads an IF statement
+ if ::= T_IF '(' expr ')' ':' ...
+
+read_if_expr
+reads an if expression : '(' expr ')'
+read_elseif_short
+reads an elseif (expr): statements
+read_else_short
+read_while
+Reads a while statement
+while ::= T_WHILE (statement | ':' inner_statement_list T_ENDWHILE ';')
+
+Returns While
+read_do
+Reads a do / while loop
+do ::= T_DO statement T_WHILE '(' expr ')' ';'
+
+Returns Do
+read_for
+Read a for incremental loop
+for ::= T_FOR '(' for_exprs ';' for_exprs ';' for_exprs ')' for_statement
+for_statement ::= statement | ':' inner_statement_list T_ENDFOR ';'
+for_exprs ::= expr? (',' expr)*
+
+Returns For
+read_foreach
+Reads a foreach loop
+foreach ::= '(' expr T_AS foreach_variable (T_DOUBLE_ARROW foreach_variable)? ')' statement
+
+Returns Foreach
+read_foreach_variable
+Reads a foreach variable statement
+foreach_variable = variable |
+ T_LIST '(' assignment_list ')' |
+ '[' array_pair_list ']'
+
+Returns Expression
+read_start
+start ::= (namespace | top_statement)*
+
+read_namespace
+Reads a namespace declaration block
+namespace ::= T_NAMESPACE namespace_name? '{'
+ top_statements
+'}'
+| T_NAMESPACE namespace_name ';' top_statements
+
+Returns Namespace
+read_namespace_name
+Reads a namespace name
+ namespace_name ::= T_NS_SEPARATOR? (T_STRING T_NS_SEPARATOR)* T_STRING
+
+Returns Identifier
+read_use_statement
+Reads a use statement
+use_statement ::= T_USE
+ use_type? use_declarations |
+ use_type use_statement '{' use_declarations '}' |
+ use_statement '{' use_declarations(=>typed) '}'
+';'
+
+Returns UseGroup
+read_use_declaration
+Reads a use declaration
+use_declaration ::= use_type? namespace_name use_alias
+
+Returns UseItem
+read_use_declarations
+Reads a list of use declarations
+use_declarations ::= use_declaration (',' use_declaration)*
+
+Returns Array<UseItem>
+read_use_alias
+Reads a use statement
+use_alias ::= (T_AS T_STRING)?
+
+Returns (String | null)
+read_use_type
+Reads the namespace type declaration
+use_type ::= (T_FUNCTION | T_CONST)?
+
+Returns (String | null) Possible values : function, const
+resolve_special_chars
+Unescape special chars
+read_scalar
+ scalar ::= T_MAGIC_CONST
+ | T_LNUMBER | T_DNUMBER
+ | T_START_HEREDOC T_ENCAPSED_AND_WHITESPACE? T_END_HEREDOC
+ | '"' encaps_list '"'
+ | T_START_HEREDOC encaps_list T_END_HEREDOC
+ | namespace_name (T_DOUBLE_COLON T_STRING)?
+
+read_dereferencable
+Handles the dereferencing
+read_encapsed_string_item
+Reads and extracts an encapsed item
+encapsed_string_item ::= T_ENCAPSED_AND_WHITESPACE
+ | T_DOLLAR_OPEN_CURLY_BRACES expr '}'
+ | T_DOLLAR_OPEN_CURLY_BRACES T_STRING_VARNAME '}'
+ | T_DOLLAR_OPEN_CURLY_BRACES T_STRING_VARNAME '[' expr ']' '}'
+ | T_CURLY_OPEN variable '}'
+ | variable
+ | variable '[' expr ']'
+ | variable T_OBJECT_OPERATOR T_STRING
+
+Returns (String | Variable | Expr | Lookup)
+read_encapsed_string
+Reads an encapsed string
+get_magic_constant
+Constant token
+read_top_statements
+reading a list of top statements (helper for top_statement*)
+ top_statements ::= top_statement*
+
+read_top_statement
+reading a top statement
+ top_statement ::=
+ namespace | function | class
+ | interface | trait
+ | use_statements | const_list
+ | statement
+
+read_inner_statements
+reads a list of simple inner statements (helper for inner_statement*)
+ inner_statements ::= inner_statement*
+
+read_const_list
+Reads a list of constants declaration
+ const_list ::= T_CONST T_STRING '=' expr (',' T_STRING '=' expr)* ';'
+
+read_declare_list
+Reads a list of constants declaration
+ declare_list ::= T_STRING '=' expr (',' T_STRING '=' expr)*
+
+read_inner_statement
+reads a simple inner statement
+ inner_statement ::= '{' inner_statements '}' | token
+
+read_statement
+Reads statements
+read_code_block
+ code_block ::= '{' (inner_statements | top_statements) '}'
+
+read_switch
+Reads a switch statement
+ switch ::= T_SWITCH '(' expr ')' switch_case_list
+
+Returns Switch
+read_switch_case_list
+ switch_case_list ::= '{' ';'? case_list* '}' | ':' ';'? case_list* T_ENDSWITCH ';'
+
+read_case_list
+ case_list ::= ((T_CASE expr) | T_DEFAULT) (':' | ';') inner_statement*
+
+read_try
+ try ::= T_TRY '{' inner_statement* '}'
+ (
+ T_CATCH '(' namespace_name variable ')' '{' inner_statement* '}'
+ )*
+ (T_FINALLY '{' inner_statement* '}')?
+
+Returns Try
+
+Reads a short form of tokens
+Parameters
+
+token Number The ending token
+Returns Block
+read_list
+Helper : reads a list of tokens / sample : T_STRING ',' T_STRING ...
+list ::= separator? ( item separator )* item
+
+read_name_list
+Reads a list of names separated by a comma
+name_list ::= namespace (',' namespace)*
+
+Sample code :
+<?php class foo extends bar, baz { }
+
+Returns Array<Identifier>
+read_variable_declarations
+Reads a list of variables declarations
+variable_declaration ::= T_VARIABLE ('=' expr)?*
+variable_declarations ::= variable_declaration (',' variable_declaration)*
+
+Sample code :
+<?php class foo extends bar, baz { }
+
+Returns (Array<Variable> | Array<Assign>) Returns an array composed by a list of variables, or
+assign values
+read_variable
+Reads a variable
+ variable ::= &? ...complex @todo
+
+Some samples of parsed code :
+ &$var // simple var
+ $var // simple var
+ classname::CONST_NAME // dynamic class name with const retrieval
+ foo() // function call
+ $var->func()->property // chained calls
+
+read_encaps_var_offset
+https://github.com/php/php-src/blob/493524454d66adde84e00d249d607ecd540de99f/Zend/zend_language_parser.y#L1231
+read_reference_variable
+ reference_variable ::= simple_variable ('[' OFFSET ']')* | '{' EXPR '}'
+
+
+ $foo[123]; // foo is an array ==> gets its entry
+ $foo{1}; // foo is a string ==> get the 2nd char offset
+ ${'foo'}[123]; // get the dynamic var $foo
+ $foo[123]{1}; // gets the 2nd char from the 123 array entry
+
+read_simple_variable
+ simple_variable ::= T_VARIABLE | '$' '{' expr '}' | '$' simple_variable
+
+
+
