class TruncateStatement extends Statement (View source)

TRUNCATE statement.

Properties

static array $OPTIONS Options for TRUNCATE statements.
static array $CLAUSES The clauses of this statement, in order. from  Statement
static array $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
Expression $table The name of the truncated table.

Methods

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

No description

string
build()

Special build method for truncate statement as Statement::build would return empty string.

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()

Special build method for truncate statement as Statement::build would return empty string.

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