abstract class Statement (View source)

Abstract statement definition.

Properties

static array $OPTIONS Options for this statement.
static array $CLAUSES The clauses of this statement, in order.
static array $END_OPTIONS
OptionsArray $options The options of this query.
int $first The index of the first token used in this statement.
int $last The index of the last token used in this statement.

Methods

__construct(Parser|null $parser = null, TokensList|null $list = null)

No description

string
build()

Builds the string representation of this statement.

parse(Parser $parser, TokensList $list)

Parses the statements defined by the tokens list.

before(Parser $parser, TokensList $list, Token $token)

Function called before the token is processed.

after(Parser $parser, TokensList $list, Token $token)

Function called after the token was processed.

array
getClauses()

Gets the clauses of this statement.

string
__toString()

Builds the string representation of this statement.

bool
validateClauseOrder(Parser $parser, TokensList $list)

Validates the order of the clauses in parsed statement Ideally this should be called after successfully completing the parsing of each statement.

Details

__construct(Parser|null $parser = null, TokensList|null $list = null)

Parameters

Parser|null $parser the instance that requests parsing
TokensList|null $list the list of tokens to be parsed

string build()

Builds the string representation of this statement.

Return Value

string

parse(Parser $parser, TokensList $list)

Parses the statements defined by the tokens list.

Parameters

Parser $parser the instance that requests parsing
TokensList $list the list of tokens to be parsed

Exceptions

ParserException

before(Parser $parser, TokensList $list, Token $token)

Function called before the token is processed.

Parameters

Parser $parser the instance that requests parsing
TokensList $list the list of tokens to be parsed
Token $token the token that is being parsed

after(Parser $parser, TokensList $list, Token $token)

Function called after the token was processed.

Parameters

Parser $parser the instance that requests parsing
TokensList $list the list of tokens to be parsed
Token $token the token that is being parsed

array getClauses()

Gets the clauses of this statement.

Return Value

array

string __toString()

Builds the string representation of this statement.

Return Value

string

See also

static::build

bool validateClauseOrder(Parser $parser, TokensList $list)

Validates the order of the clauses in parsed statement Ideally this should be called after successfully completing the parsing of each statement.

Parameters

Parser $parser the instance that requests parsing
TokensList $list the list of tokens to be parsed

Return Value

bool

Exceptions

ParserException