• Location
• Position
• Node
  • Identifier
  • TraitUse
  • TraitAlias
  • TraitPrecedence
  • Entry
  • Case
  • Label
  • Doc
  • Error
  • Expression
    • Array
    • Variable
    • Variadic
    • ConstRef
    • Yield
    • YieldFrom
    • Lookup
      • PropertyLookup
      • StaticLookup
      • OffsetLookup
    • Operation
      • Pre
      • Post
      • Bin
      • Parenthesis
      • Unary
      • Cast
    • Literal
      • Boolean
      • String
      • Number
      • Inline
      • Magic
      • Nowdoc
      • Encapsed
  • Statement
    • Eval
    • Exit
    • Halt
    • Clone
    • Declare
    • Global
    • Static
    • Include
    • Assign
    • RetIf
    • If
    • Do
    • While
    • For
    • Foreach
    • Switch
    • Goto
    • Silent
    • Try
    • Catch
    • Throw
    • Call
    • Closure
    • New
    • UseGroup
    • UseItem
    • Block
      • Program
      • Namespace
    • Sys
      • Echo
      • List
      • Print
      • Isset
      • Unset
      • Empty
    • Declaration
      • Class
      • Interface
      • Trait
      • Constant
        • ClassConstant
      • Function
        • Method
      • Parameter
      • Property

Parameters

• withPositions
• withSource

Check and fix precence, by default using right

Parameters

• result

Prepares an AST node

Parameters

• kind (String | null) Defines the node type (if null, the kind must be passed at the function call)
• parser Parser The parser instance (use for extracting locations)

Returns Function

The AST builder class

Parameters

• withPositions
• withSource

Properties

• withPositions Boolean Should locate any node (by default false)
• withSource Boolean Should extract the node original code (by default false)

Check and fix precence, by default using right

Parameters

• result

Prepares an AST node

Parameters

• kind (String | null) Defines the node type (if null, the kind must be passed at the function call)
• parser Parser The parser instance (use for extracting locations)

Returns Function

Extends Expression

Defines an array structure

Properties

• items Array<Entry> List of array items
• shortForm boolean Indicate if the short array syntax is used, ex [] instead array()

Examples

// PHP code :
[1, 'foo' => 'bar', 3]

// AST structure :
{
 "kind": "array",
 "shortForm": true
 "items": [{
   "kind": "entry",
   "key": null,
   "value": {"kind": "number", "value": "1"}
 }, {
   "kind": "entry",
   "key": {"kind": "string", "value": "foo", "isDoubleQuote": false},
   "value": {"kind": "string", "value": "bar", "isDoubleQuote": false}
 }, {
   "kind": "entry",
   "key": null,
   "value": {"kind": "number", "value": "3"}
 }]
}

Extends Statement

Assigns a value to the specified target

Properties

• left Expression
• right Expression
• operator String

Extends Operation

Binary operations

Properties

• type String
• left Expression
• right Expression

Extends Statement

A block statement, i.e., a sequence of statements surrounded by braces.

Properties

• children Array<Node>

Extends Literal

Defines a boolean value (true/false)

Extends Node

A break statement

Properties

• level (Number | Null)

Extends Statement

Executes a call statement

Properties

• arguments Array<Arguments>

Extends Node

A switch case statement

Properties

• test (Expression | null) if null, means that the default case
• body (Block | null)

Extends Operation

Binary operations

Properties

• type String
• what Expression

Extends Statement

Defines a catch statement

Properties

• what Array<Identifier>
• variable Variable
• body Statement

Extends Declaration

A class definition

Properties

• extends (Identifier | null)
• implements Array<Identifier>
• body Array<Declaration>
• isAnonymous boolean
• isAbstract boolean
• isFinal boolean

Extends Constant

Defines a class/interface/trait constant

Properties

• isStatic boolean
• visibility string

Extends Statement

Defines a clone call

Properties

• what Expression

Extends Statement

Defines a closure

Properties

• arguments Array<Parameter>
• uses Array<Variable>
• type Identifier
• byref boolean
• nullable boolean
• body (Block | null)
• isStatic boolean

Extends Declaration

Defines a namespace constant

Properties

• value (Node | null)

Extends Expression

A constant reference

Properties

• name (String | Node)

Extends Node

A continue statement

Properties

• level (Number | Null)

Extends Statement

A declaration statement (function, class, interface...)

Properties

• name string

Generic flags parser

Parameters

• flags Array<Integer>

Returns void

Extends Block

The declare construct is used to set execution directives for a block of code

Properties

• what Array<Expression>
• mode String

The node is declared as a short tag syntax :

<?php
declare(ticks=1):
// some statements
enddeclare;

Type: String

The node is declared bracket enclosed code :

<?php
declare(ticks=1) {
// some statements
}

Type: String

The node is declared as a simple statement. In order to make things simpler children of the node are automatically collected until the next declare statement.

<?php
declare(ticks=1);
// some statements
declare(ticks=2);
// some statements

Type: String

Extends Statement

Defines a do/while statement

Properties

• test Expression
• body Statement

Extends Node

A comment or documentation

Properties

• isDoc Boolean
• lines Array<String>

Extends Sys

Defines system based call

Extends Sys

Defines an empty check call

Extends Literal

Defines an encapsed string (contains expressions)

Properties

• type String Defines the type of encapsed string (shell, heredoc, string)
• label (String | Null) The heredoc label, defined only when the type is heredoc

The node is a double quote string :

<?php
echo "hello $world";

Type: String

The node is a shell execute string :

<?php
echo `ls -larth $path`;

Type: String

The node is a shell execute string :

<?php
echo <<<STR
 Hello $world
STR
;

Type: String

The node contains a list of constref / variables / expr :

<?php
echo $foo->bar_$baz;

Type: String

Extends Node

An array entry - see Array

Properties

• key (Node | null) The entry key/offset
• value Node The entry value

Extends Node

Defines an error node (used only on silentMode)

Properties

• message string
• line number
• token (number | string)
• expected (string | array)

Extends Statement

Defines an eval statement

Properties

• source Node

Extends Statement

Defines an exit / die call

Properties

• status (Node | null)

Extends Node

Any expression node. Since the left-hand side of an assignment may be any expression in general, an expression can also be a pattern.

Extends Statement

Defines a for iterator

Properties

• init Array<Expression>
• test Array<Expression>
• increment Array<Expression>
• body Statement
• shortForm boolean

Extends Statement

Defines a foreach iterator

Properties

• source Expression
• key (Expression | null)
• value Expression
• body Statement
• shortForm boolean

Extends Declaration

Defines a classic function

Properties

• arguments Array<Parameter>
• type Identifier
• byref boolean
• nullable boolean
• body (Block | null)

Extends Statement

Imports a variable from the global scope

Properties

• items Array<Variable>

Extends Statement

Defines goto statement

Properties

• label String

Extends Statement

Halts the compiler execution

Properties

• after String String after the halt statement

Extends Node

Defines an identifier node

Properties

• name string
• resolution string

This is an identifier without a namespace separator, such as Foo

Type: String

This is an identifier with a namespace separator, such as Foo\Bar

Type: String

This is an identifier with a namespace separator that begins with a namespace separator, such as \Foo\Bar. The namespace \Foo is also a fully qualified name.

Type: String

This is an identifier starting with namespace, such as namespace\Foo\Bar.

Type: String

Extends Statement

Defines a if statement

Properties

• test Expression
• body Block
• alternate (Block | If | null)
• shortForm boolean

Extends Statement

Defines system include call

Properties

• target Node
• once boolean
• require boolean

Extends Literal

Defines inline html output (treated as echo output)

Extends Declaration

An interface definition

Properties

• extends Array<Identifier>
• body Array<Declaration>

Extends Sys

Defines an isset call

Extends Node

A label statement (referenced by goto)

Properties

• name String

Extends Sys

Defines list assignment

Extends Expression

Defines an array structure

Properties

• value (Node | string | number | boolean | null)

Defines the location of the node (with it's source contents as string)

Parameters

• source
• start
• end

Properties

• source (String | null)
• start Position
• end Position

Extends Expression

Lookup on an offset in the specified object

Properties

• what Expression
• offset Expression

Extends Literal

Defines magic constant

Extends Function

Defines a class/interface/trait method

Properties

• isAbstract boolean
• isFinal boolean
• isStatic boolean
• visibility string

Extends Block

The main program node

Properties

• name String
• withBrackets Boolean

Extends Statement

Creates a new instance of the specified class

Properties

• what (Identifier | Variable | Class)
• arguments Array<Arguments>

A generic AST node

Parameters

• kind
• location

Properties

• loc (Location | null)
• kind String

Helper for extending the Node class

Parameters

• constructor Function

Returns Function

Extends Literal

Defines a nowdoc string

Properties

• label String

Extends Literal

Defines a string (simple ou double quoted) - chars are already escaped

Properties

• isDoubleQuote boolean

Extends Literal

Defines a numeric value

Extends Lookup

Lookup on an offset in an array

Extends Expression

Defines binary operations

Extends Declaration

Defines a function parameter

Properties

• type (Identifier | null)
• value (Node | null)
• byref boolean
• variadic boolean
• nullable boolean

Extends Operation

Parenthesis encapsulation (... expr ...)

Properties

• inner Expression

Each Position object consists of a line number (1-indexed) and a column number (0-indexed):

Parameters

• line
• column
• offset

Properties

• line Number
• column Number
• offset Number

Extends Operation

Defines a post operation $i++ or $i--

Properties

• type String
• what Variable

Extends Operation

Defines a pre operation ++$i or --$i

Properties

• type String
• what Variable

Extends Sys

Outputs

Extends Block

The main program node

Properties

• errors Array<Error>

Extends Declaration

Defines a class property

Properties

• isFinal boolean
• isStatic boolean
• visibility string
• value (Node | null)

Extends Lookup

Lookup to an object property

Extends Statement

Defines a short if statement that returns a value

Properties

• test Expression
• trueExpr Expression
• falseExpr Expression

Extends Node

A continue statement

Properties

• expr (Expression | null)

Extends Statement

Avoids to show/log warnings & notices from the inner expression

Properties

• expr Expression

Extends Node

Any statement.

Extends Statement

Declares a static variable into the current scope

Properties

• items (Array<Variable> | Array<Assign>)

Extends Lookup

Lookup to a static property

Extends Statement

Defines a switch statement

Properties

• test Expression
• body Block
• shortForm boolean

Extends Statement

Defines system based call

Properties

• arguments Array<Node>

Extends Statement

Defines a throw statement

Properties

• what Expression

Extends Declaration

A trait definition

Properties

• extends (Identifier | null)
• implements Array<Identifier>
• body Array<Declaration>

Extends Node

Defines a trait alias

Properties

• trait (Identifier | null)
• method string
• as (string | null)
• visibility (string | null)

Extends Node

Defines a trait alias

Properties

• trait (Identifier | null)
• method string
• instead Array<Identifier>

Extends Node

Defines a trait usage

Properties

• traits Array<Identifier>
• adaptations (Array<Node> | null)

Extends Statement

Defines a try statement

Properties

• body Block
• catches Array<Catch>
• allways Block

Extends Operation

Unary operations

Properties

• type String
• what Expression

Extends Sys

Deletes references to a list of variables

Extends Statement

Defines a use statement (with a list of use items)

Properties

• name (String | null)
• type (String | null) Possible value : function, const
• item Array<UseItem>

Extends Statement

Defines a use statement (from namespace)

Properties

• name String
• type (String | null) Possible value : function, const
• alias (String | null)

Importing a constant

Type: String

Importing a function

Type: String

Extends Expression

Any expression node. Since the left-hand side of an assignment may be any expression in general, an expression can also be a pattern.

Properties

• name (String | Node) The variable name (can be a complex expression when the name is resolved dynamically)
• byref boolean Indicate if the variable reference is used, ex &$foo
• curly boolean Indicate if the name is defined between curlies, ex ${foo}

Examples

// PHP code :
&$foo
// AST output
{
 "kind": "variable",
 "name": "foo",
 "byref": true,
 "curly": false
}

Extends Expression

Introduce a list of items into the arguments of the call

Properties

• what (Array | Expression)

Extends Statement

Defines a while statement

Properties

• test Expression
• body Statement
• shortForm boolean

Extends Expression

Defines a yield generator statement

Properties

• value (Expression | Null)
• key (Expression | Null)

Extends Expression

Defines a yield from generator statement

Properties

• value Expression