1. class
  2. PhpMyAdmin
  3. \
  4. SqlParser
  5. \
  6. Statements
  7. \
  8. ExplainStatement

ExplainStatement

class ExplainStatement extends NotImplementedStatement

EXPLAIN statement.

Properties

static array $OPTIONS Options for this statement. from Statement
static array $CLAUSES The clauses of this statement, in order. from Statement
static $END_OPTIONS from Statement
OptionsArray $options The options of this query. from Statement
int $first The index of the first token used in this statement. from Statement
int $last The index of the last token used in this statement. from Statement
Token[] $unknown The part of the statement that can't be parsed. from NotImplementedStatement

Methods

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

Constructor.

from Statement
string
build()

Builds the string representation of this statement.

from NotImplementedStatement
parse(Parser $parser, TokensList $list)

Parses the statements defined by the tokens list.

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

Function called before the token is processed.

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

Function called after the token was processed.

from Statement
array
getClauses()

Gets the clauses of this statement.

from Statement
string
__toString()

Builds the string representation of this statement.

from 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.

from Statement

Details

in Statement at line 90
__construct(Parser $parser = null, TokensList $list = null)

Constructor.

Parameters

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

in NotImplementedStatement at line 35
string build()

Builds the string representation of this statement.

Return Value

string

in NotImplementedStatement at line 52
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

in Statement at line 426
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

in Statement at line 437
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

in Statement at line 446
array getClauses()

Gets the clauses of this statement.

Return Value

array

in Statement at line 458
string __toString()

Builds the string representation of this statement.

Return Value

string

See also

in Statement at line 473
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