A

AlterOperation — Class in namespace PhpMyAdmin\SqlParser\Components

Parses an alter operation.

ArrayObj — Class in namespace PhpMyAdmin\SqlParser\Components

Parses an array.

$ CaseExpression#alias — Property in class CaseExpression

The alias of this CASE statement.

$ Expression#alias — Property in class Expression

The alias of this expression.

AlterOperations — Class in namespace PhpMyAdmin\SqlParser\Parsers

Parses an alter operation.

Array2d — Class in namespace PhpMyAdmin\SqlParser\Parsers

VALUES keyword parser.

ArrayObjs — Class in namespace PhpMyAdmin\SqlParser\Parsers

Parses an array.

Statement::after() — Method in class Statement

Function called after the token was processed.

AlterStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

ALTER statement.

$ AlterStatement#altered — Property in class AlterStatement

Column affected by this statement.

AnalyzeStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

ANALYZE statement.

MaintenanceStatement::after() — Method in class MaintenanceStatement

Function called after the token was processed.

UpdateStatement::after() — Method in class UpdateStatement

Function called after the token was processed.

TokensList::add() — Method in class TokensList

Adds a new token.

B

Component::build() — Method in class Component

Builds the string representation of a component of this type.

AlterOperation::build() — Method in class AlterOperation

Builds the string representation of a component of this type.

ArrayObj::build() — Method in class ArrayObj

Builds the string representation of a component of this type.

CaseExpression::build() — Method in class CaseExpression

Builds the string representation of a component of this type.

Condition::build() — Method in class Condition

Builds the string representation of a component of this type.

CreateDefinition::build() — Method in class CreateDefinition

Builds the string representation of a component of this type.

DataType::build() — Method in class DataType

Builds the string representation of a component of this type.

Expression::build() — Method in class Expression

Builds the string representation of a component of this type.

FunctionCall::build() — Method in class FunctionCall

Builds the string representation of a component of this type.

GroupKeyword::build() — Method in class GroupKeyword

Builds the string representation of a component of this type.

IndexHint::build() — Method in class IndexHint

Builds the string representation of a component of this type.

IntoKeyword::build() — Method in class IntoKeyword

Builds the string representation of a component of this type.

JoinKeyword::build() — Method in class JoinKeyword

Builds the string representation of a component of this type.

Key::build() — Method in class Key

Builds the string representation of a component of this type.

Limit::build() — Method in class Limit

Builds the string representation of a component of this type.

LockExpression::build() — Method in class LockExpression

Builds the string representation of a component of this type.

LockExpression::buildAll() — Method in class LockExpression
OptionsArray::build() — Method in class OptionsArray

Builds the string representation of a component of this type.

OrderKeyword::build() — Method in class OrderKeyword

Builds the string representation of a component of this type.

ParameterDefinition::build() — Method in class ParameterDefinition

Builds the string representation of a component of this type.

PartitionDefinition::build() — Method in class PartitionDefinition

Builds the string representation of a component of this type.

Reference::build() — Method in class Reference

Builds the string representation of a component of this type.

RenameOperation::build() — Method in class RenameOperation

Builds the string representation of a component of this type.

SetOperation::build() — Method in class SetOperation

Builds the string representation of a component of this type.

WithKeyword::build() — Method in class WithKeyword

Builds the string representation of a component of this type.

$ Parser#brackets — Property in class Parser

The number of opened brackets.

ArrayObjs::buildAll() — Method in class ArrayObjs
Conditions::buildAll() — Method in class Conditions
CreateDefinitions::buildAll() — Method in class CreateDefinitions
ExpressionArray::buildAll() — Method in class ExpressionArray
Expressions::buildAll() — Method in class Expressions
GroupKeywords::buildAll() — Method in class GroupKeywords
IndexHints::buildAll() — Method in class IndexHints
JoinKeywords::buildAll() — Method in class JoinKeywords
OrderKeywords::buildAll() — Method in class OrderKeywords
ParameterDefinitions::buildAll() — Method in class ParameterDefinitions
PartitionDefinitions::buildAll() — Method in class PartitionDefinitions
RenameOperations::buildAll() — Method in class RenameOperations
SetOperations::buildAll() — Method in class SetOperations
UnionKeywords::buildAll() — Method in class UnionKeywords
Statement::build() — Method in class Statement

Builds the string representation of this statement.

Statement::before() — Method in class Statement

Function called before the token is processed.

AlterStatement::build() — Method in class AlterStatement

Builds the string representation of this statement.

BackupStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

BACKUP statement.

CallStatement::build() — Method in class CallStatement

Build statement for CALL.

$ CreateStatement#body — Property in class CreateStatement

The body of this function or procedure.

CreateStatement::build() — Method in class CreateStatement

Builds the string representation of this statement.

DeleteStatement::build() — Method in class DeleteStatement

Builds the string representation of this statement.

$ ExplainStatement#bodyParser — Property in class ExplainStatement

The parser of the statement to be explained

ExplainStatement::build() — Method in class ExplainStatement

Builds the string representation of this statement.

InsertStatement::build() — Method in class InsertStatement

Builds the string representation of this statement.

KillStatement::build() — Method in class KillStatement

Builds the string representation of this statement.

LoadStatement::build() — Method in class LoadStatement

Builds the string representation of this statement.

LockStatement::build() — Method in class LockStatement

Builds the string representation of this statement.

NotImplementedStatement::build() — Method in class NotImplementedStatement

Builds the string representation of this statement.

PurgeStatement::build() — Method in class PurgeStatement

Builds the string representation of this statement.

RenameStatement::before() — Method in class RenameStatement

Function called before the token is processed.

RenameStatement::build() — Method in class RenameStatement

Builds the string representation of this statement.

ReplaceStatement::build() — Method in class ReplaceStatement

Builds the string representation of this statement.

SetStatement::build() — Method in class SetStatement

Builds the string representation of this statement.

TransactionStatement::build() — Method in class TransactionStatement

Builds the string representation of this statement.

TruncateStatement::build() — Method in class TruncateStatement

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

WithStatement::build() — Method in class WithStatement

Builds the string representation of this statement.

TokensList::build() — Method in class TokensList

Builds an array of tokens by merging their raw value.

TokensList::buildFromArray() — Method in class TokensList

Builds an array of tokens by merging their raw value.

ContextGenerator::build() — Method in class ContextGenerator

Builds a test.

ContextGenerator::buildAll() — Method in class ContextGenerator

Generates recursively all tests preserving the directory structure.

TestGenerator::build() — Method in class TestGenerator

Builds a test.

TestGenerator::buildAll() — Method in class TestGenerator

Generates recursively all tests preserving the directory structure.

BufferedQuery — Class in namespace PhpMyAdmin\SqlParser\Utils

Buffer query utilities.

C

Component — Class in namespace PhpMyAdmin\SqlParser

Defines a component that is later extended to parse specialized components or keywords.

CaseExpression — Class in namespace PhpMyAdmin\SqlParser\Components

Parses a reference to a CASE expression.

$ CaseExpression#conditions — Property in class CaseExpression

The conditions in WHEN clauses.

$ CaseExpression#compareValues — Property in class CaseExpression

The values to be compared against.

Condition — Class in namespace PhpMyAdmin\SqlParser\Components
CreateDefinition — Class in namespace PhpMyAdmin\SqlParser\Components

Parses the create definition of a column or a key.

$ Expression#column — Property in class Expression

The name of the column.

$ IntoKeyword#columns — Property in class IntoKeyword

The name of the columns.

$ Key#columns — Property in class Key

The key columns

$ Reference#columns — Property in class Reference

The referenced columns.

$ SetOperation#column — Property in class SetOperation

The name of the column that is being updated.

$ WithKeyword#columns — Property in class WithKeyword
Context — Class in namespace PhpMyAdmin\SqlParser

Defines a context class that is later extended to define other contexts.

ContextMariaDb100000 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 10.0.

ContextMariaDb100100 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 10.1.

ContextMariaDb100200 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 10.2.

ContextMariaDb100300 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 10.3.

ContextMariaDb100400 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 10.4.

ContextMariaDb100500 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 10.5.

ContextMariaDb100600 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 10.6.

ContextMariaDb100700 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 10.7.

ContextMariaDb100800 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 10.8.

ContextMariaDb100900 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 10.9.

ContextMariaDb101000 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 10.10.

ContextMariaDb101100 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 10.11.

ContextMariaDb110000 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 11.0.

ContextMariaDb110100 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 11.1.

ContextMariaDb110200 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 11.2.

ContextMariaDb110300 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 11.3.

ContextMariaDb110400 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 11.4.

ContextMariaDb110500 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 11.5.

ContextMariaDb110600 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 11.6.

ContextMariaDb110700 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 11.7.

ContextMariaDb110800 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 11.8.

ContextMariaDb120000 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 12.0.

ContextMariaDb120100 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 12.1.

ContextMySql50000 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 5.0.

ContextMySql50100 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 5.1.

ContextMySql50500 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 5.5.

ContextMySql50600 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 5.6.

ContextMySql50700 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 5.7.

ContextMySql80000 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 8.0.

ContextMySql80100 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 8.1.

ContextMySql80200 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 8.2.

ContextMySql80300 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 8.3.

ContextMySql80400 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 8.4.

ContextMySql90000 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 9.0.

ContextMySql90100 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 9.1.

ContextMySql90200 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 9.2.

ContextMySql90300 — Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 9.3.

$ LexerException#ch — Property in class LexerException

The character that produced this error.

CaseExpressions — Class in namespace PhpMyAdmin\SqlParser\Parsers

Parses a reference to a CASE expression.

Conditions — Class in namespace PhpMyAdmin\SqlParser\Parsers

WHERE keyword parser.

CreateDefinitions — Class in namespace PhpMyAdmin\SqlParser\Parsers

Parses the create definition of a column or a key.

$ Statement#clauses — Property in class Statement

The clauses of this statement, in order.

CallStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

CALL statement.

$ CallStatement#call — Property in class CallStatement

The name of the function and its parameters.

CheckStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

CHECK statement.

ChecksumStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

CHECKSUM statement.

CreateStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

CREATE statement.

$ DeleteStatement#clauses — Property in class DeleteStatement

The clauses of this statement, in order.

$ DeleteStatement#columns — Property in class DeleteStatement

Columns used in this statement.

$ DropStatement#clauses — Property in class DropStatement

The clauses of this statement, in order.

$ ExplainStatement#connectionId — Property in class ExplainStatement

The connection identifier, if used.

$ LoadStatement#charsetName — Property in class LoadStatement

Character set used in this statement.

$ LoadStatement#columnNamesOrUserVariables — Property in class LoadStatement

Column names or user variables.

$ SelectStatement#clauses — Property in class SelectStatement

The clauses of this statement, in order.

$ SetStatement#clauses — Property in class SetStatement

The clauses of this statement, in order.

$ UpdateStatement#clauses — Property in class UpdateStatement

The clauses of this statement, in order.

$ WithStatement#clauses — Property in class WithStatement

The clauses of this statement, in order.

$ WithStatement#cteStatementParser — Property in class WithStatement

holds the CTE parser.

$ TokensList#count — Property in class TokensList

The count of tokens.

ContextGenerator — Class in namespace PhpMyAdmin\SqlParser\Tools

Used for context generation.

CustomJsonSerializer — Class in namespace PhpMyAdmin\SqlParser\Tools

Used for .out files generation

$ UtfString#characters — Property in class UtfString

The multi-byte characters.

$ BufferedQuery#current — Property in class BufferedQuery

The last incomplete query that was extracted.

CLI — Class in namespace PhpMyAdmin\SqlParser\Utils

CLI interface.

D

DataType — Class in namespace PhpMyAdmin\SqlParser\Components

Parses a data type.

$ Expression#database — Property in class Expression

The name of this database.

$ IntoKeyword#dest — Property in class IntoKeyword

The destination, which can be a table or a file.

$ Lexer#defaultDelimiter — Property in class Lexer

The default delimiter. This is used, by default, in all new instances.

$ Lexer#delimiter — Property in class Lexer

Statements delimiter.

$ Lexer#delimiterLen — Property in class Lexer

The length of the delimiter.

DataTypes — Class in namespace PhpMyAdmin\SqlParser\Parsers

Parses a data type.

DeleteStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

DELETE statement.

DropStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

DROP statement.

$ BufferedQuery#delimiter — Property in class BufferedQuery

The last delimiter used.

$ BufferedQuery#delimiterLen — Property in class BufferedQuery

The length of the delimiter.

$ StatementFlags#distinct — Property in class StatementFlags

select ... DISTINCT .

$ StatementFlags#dropDatabase — Property in class StatementFlags

drop ... DATABASE .

E

$ CaseExpression#elseResult — Property in class CaseExpression

The result in ELSE section of expr.

$ CaseExpression#expr — Property in class CaseExpression

The sub-expression.

$ Condition#expr — Property in class Condition

The condition.

Expression — Class in namespace PhpMyAdmin\SqlParser\Components

Parses a reference to an expression (column, table or database name, function call, mathematical expression, etc.).

$ Expression#expr — Property in class Expression

The sub-expression.

$ GroupKeyword#expr — Property in class GroupKeyword

The expression that is used for grouping.

$ JoinKeyword#expr — Property in class JoinKeyword

Join expression.

$ Key#expr — Property in class Key

The expression if the Key is not using column names

$ OrderKeyword#expr — Property in class OrderKeyword

The expression that is used for ordering.

$ PartitionDefinition#expr — Property in class PartitionDefinition

The expression used to defined this partition.

Context::escape() — Method in class Context

Escapes the symbol by adding surrounding backticks.

Context::escapeAll() — Method in class Context

Escapes the symbol by adding surrounding backticks.

$ Lexer#errors — Property in class Lexer

List of errors that occurred during lexing.

Lexer::error() — Method in class Lexer

Creates a new error log.

$ Parser#errors — Property in class Parser

List of errors that occurred during lexing.

Parser::error() — Method in class Parser

Creates a new error log.

ExpressionArray — Class in namespace PhpMyAdmin\SqlParser\Parsers

Parses a list of expressions delimited by a comma.

Expressions — Class in namespace PhpMyAdmin\SqlParser\Parsers

Parses a reference to an expression (column, table or database name, function call, mathematical expression, etc.).

$ CreateStatement#entityOptions — Property in class CreateStatement

The options of the entity (table, procedure, function, etc.).

ExplainStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

EXPLAIN statement.

$ ExplainStatement#explainedDatabase — Property in class ExplainStatement

The explained database for the table's name, if used.

$ ExplainStatement#explainedTable — Property in class ExplainStatement

The explained table's name, if used.

$ ExplainStatement#explainedColumn — Property in class ExplainStatement

The explained column's name, if used.

$ PurgeStatement#endOption — Property in class PurgeStatement

The end option of this query.

$ PurgeStatement#endExpr — Property in class PurgeStatement

The end expr of this query.

$ SelectStatement#expr — Property in class SelectStatement

Expressions that are being selected by this statement.

$ SelectStatement#endOptions — Property in class SelectStatement

The end options of this query.

$ SetStatement#endOptions — Property in class SetStatement

The end options of this query.

$ TransactionStatement#end — Property in class TransactionStatement

The ending transaction statement which may be a COMMIT or a ROLLBACK.

Token::extract() — Method in class Token

Does a little processing to the token to extract a value.

CustomJsonSerializer::extractObjectData() — Method in class CustomJsonSerializer

Extract the object data

BufferedQuery::extract() — Method in class BufferedQuery

Extracts a statement from the buffer.

Error — Class in namespace PhpMyAdmin\SqlParser\Utils

Error related utilities.

Formatter::escapeConsole() — Method in class Formatter

F

$ AlterOperation#field — Property in class AlterOperation

The altered field.

$ Expression#function — Property in class Expression

The name of the function.

FunctionCall — Class in namespace PhpMyAdmin\SqlParser\Components

Parses a function call.

$ IntoKeyword#fieldsOptions — Property in class IntoKeyword

Options for FIELDS/COLUMNS keyword.

$ IntoKeyword#fieldsKeyword — Property in class IntoKeyword

Whether to use FIELDS or COLUMNS while building.

FunctionCalls — Class in namespace PhpMyAdmin\SqlParser\Parsers

Parses a function call.

$ Statement#first — Property in class Statement

The index of the first token used in this statement.

$ CreateStatement#fields — Property in class CreateStatement

If CREATE TABLE, a list of columns and keys.

$ DeleteStatement#from — Property in class DeleteStatement

Table(s) used as sources for this statement.

$ DropStatement#fields — Property in class DropStatement

Dropped elements.

$ LoadStatement#fileName — Property in class LoadStatement

File name being used to load data.

$ LoadStatement#fieldsOptions — Property in class LoadStatement

Options for FIELDS/COLUMNS keyword.

$ LoadStatement#fieldsKeyword — Property in class LoadStatement

Whether to use FIELDS or COLUMNS while building.

$ SelectStatement#from — Property in class SelectStatement

Tables used as sources for this statement.

$ Token#flags — Property in class Token

The flags of this token.

ContextGenerator::formatName() — Method in class ContextGenerator

Formats context name.

Error::format() — Method in class Error

Formats the specified errors.

ForeignKey — Class in namespace PhpMyAdmin\SqlParser\Utils
Formatter — Class in namespace PhpMyAdmin\SqlParser\Utils

Utilities that are used for formatting queries.

Formatter::formatList() — Method in class Formatter

Formats the given list of tokens.

Formatter::format() — Method in class Formatter

Formats a query.

FormattingOptions — Class in namespace PhpMyAdmin\SqlParser\Utils
$ Query#functions — Property in class Query

Functions that set the flag is_func.

G

GroupKeyword — Class in namespace PhpMyAdmin\SqlParser\Components

GROUP BY keyword parser.

OptionsArray::get() — Method in class OptionsArray

Checks if it has the specified option and returns its value.

Context::getMode() — Method in class Context

Gets the SQL mode.

GroupKeywords — Class in namespace PhpMyAdmin\SqlParser\Parsers

GROUP BY keyword parser.

Statement::getClauses() — Method in class Statement

Gets the clauses of this statement.

Statement::getClauseOrder() — Method in class Statement

Gets the clause order of this statement as an array with clause as key and index as value.

CreateStatement::getForeignKeys() — Method in class CreateStatement
$ SelectStatement#group — Property in class SelectStatement

Conditions used for grouping the result set.

$ SelectStatement#groupOptions — Property in class SelectStatement

List of options available for the GROUP BY component.

SelectStatement::getClauses() — Method in class SelectStatement

Gets the clauses of this statement.

SelectStatement::getAliases() — Method in class SelectStatement

Gets a list of all aliases and their original names.

Token::getInlineToken() — Method in class Token

Converts the token into an inline token by replacing tabs and new lines.

TokensList::getNext() — Method in class TokensList

Gets the next token. Skips any irrelevant token (whitespaces and comments).

TokensList::getPrevious() — Method in class TokensList

Gets the previous token. Skips any irrelevant token (whitespaces and comments).

TokensList::getPreviousOfType() — Method in class TokensList

Gets the previous token.

TokensList::getNextOfType() — Method in class TokensList

Gets the next token.

TokensList::getNextOfTypeAndValue() — Method in class TokensList

Gets the next token.

TokensList::getNextOfTypeAndFlag() — Method in class TokensList

Gets the next token.

ContextGenerator::generate() — Method in class ContextGenerator

Generates a context's class.

TestGenerator::generate() — Method in class TestGenerator

Generates a test's data.

Translator::gettext() — Method in class Translator

Translates a string.

Translator::getLocale() — Method in class Translator
CLI::getopt() — Method in class CLI
Error::get() — Method in class Error

Gets the errors of a lexer and a parser.

Formatter::getGroupLength() — Method in class Formatter

Computes the length of a group.

FormattingOptions::getDefaultFormats() — Method in class FormattingOptions

The styles used for HTML formatting.

Query::getFlags() — Method in class Query

Gets an array with flags this statement has.

Query::getAll() — Method in class Query

Parses a query and gets all information about it.

Query::getTables() — Method in class Query

Gets a list of all tables used in this statement.

Query::getClause() — Method in class Query

Gets a specific clause.

Query::getFirstStatement() — Method in class Query

Gets the first full statement in the query.

Query::getClauseStartOffset() — Method in class Query

Gets a starting offset of a specific clause.

$ StatementFlags#group — Property in class StatementFlags
Table::getFields() — Method in class Table

Gets fields of the table.

H

OptionsArray::has() — Method in class OptionsArray
Context::hasMode() — Method in class Context

Function verifies that given SQL Mode constant is currently set

$ SelectStatement#having — Property in class SelectStatement

Conditions used for filtering the result set.

$ StatementFlags#having — Property in class StatementFlags

I

$ Condition#identifiers — Property in class Condition

Identifiers recognized.

$ Condition#isOperator — Property in class Condition

Whether this component is an operator.

$ CreateDefinition#isConstraint — Property in class CreateDefinition

Whether this field is a constraint or not.

IndexHint — Class in namespace PhpMyAdmin\SqlParser\Components

Parses an Index hint.

IntoKeyword — Class in namespace PhpMyAdmin\SqlParser\Components

INTO keyword parser.

$ JoinKeyword#indexHints — Property in class JoinKeyword

Index hints

OptionsArray::isEmpty() — Method in class OptionsArray

Checks tf there are no options set.

$ ParameterDefinition#inOut — Property in class ParameterDefinition

Parameter's direction (IN, OUT or INOUT).

$ PartitionDefinition#isSubpartition — Property in class PartitionDefinition

Whether this entry is a subpartition or a partition.

Context::isKeyword() — Method in class Context

Checks if the given string is a keyword.

Context::isOperator() — Method in class Context

Checks if the given string is an operator and returns the appropriate flag for the operator.

Context::isWhitespace() — Method in class Context

Checks if the given character is a whitespace.

Context::isComment() — Method in class Context

Checks if the given string is the beginning of a whitespace.

Context::isBool() — Method in class Context

Checks if the given string is a boolean value.

Context::isNumber() — Method in class Context

Checks if the given character can be a part of a number.

Context::isSymbol() — Method in class Context

Checks if the given character is the beginning of a symbol. A symbol can be either a variable or a field name.

Context::isString() — Method in class Context

Checks if the given character is the beginning of a string.

Context::isSeparator() — Method in class Context

Checks if the given character can be a separator for two lexeme.

IndexHints — Class in namespace PhpMyAdmin\SqlParser\Parsers

Parses an Index hint.

IntoKeywords — Class in namespace PhpMyAdmin\SqlParser\Parsers

INTO keyword parser.

InsertStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

INSERT statement.

$ InsertStatement#into — Property in class InsertStatement

Tables used as target for this statement.

$ KillStatement#identifier — Property in class KillStatement

Holds the identifier if explicitly set

$ KillStatement#idKeywordUsed — Property in class KillStatement

Whether MariaDB ID keyword is used or not.

$ LoadStatement#ignoreNumber — Property in class LoadStatement

Ignore 'number' LINES/ROWS.

$ LockStatement#isLock — Property in class LockStatement

Whether it's a LOCK statement if false, it's an UNLOCK statement

$ ReplaceStatement#into — Property in class ReplaceStatement

Tables used as target for this statement.

$ SelectStatement#indexHints — Property in class SelectStatement

Index hints

$ SelectStatement#into — Property in class SelectStatement

Destination of this result set.

$ TokensList#idx — Property in class TokensList

The index of the next token to be returned.

$ Formatter#inlineClauses — Property in class Formatter

Clauses that must be inlined.

Formatter::isClause() — Method in class Formatter

Checks if a token is a statement or a clause inside a statement.

$ FormattingOptions#indentation — Property in class FormattingOptions
$ StatementFlags#isAffected — Property in class StatementFlags

INSERT ... or REPLACE ... or DELETE .

$ StatementFlags#isAnalyse — Property in class StatementFlags

select ... PROCEDURE ANALYSE( ... ) .

$ StatementFlags#isCount — Property in class StatementFlags

select COUNT( ... ) .

$ StatementFlags#isDelete — Property in class StatementFlags

DELETE .

$ StatementFlags#isExplain — Property in class StatementFlags

EXPLAIN .

$ StatementFlags#isExport — Property in class StatementFlags

select ... INTO OUTFILE .

$ StatementFlags#isFunc — Property in class StatementFlags

select FUNC( ... ) .

$ StatementFlags#isGroup — Property in class StatementFlags

select ... GROUP BY ... or select ... HAVING .

$ StatementFlags#isInsert — Property in class StatementFlags

INSERT ... or REPLACE ... or LOAD DATA .

$ StatementFlags#isMaint — Property in class StatementFlags

ANALYZE ... or CHECK ... or CHECKSUM ... or OPTIMIZE ... or REPAIR .

$ StatementFlags#isProcedure — Property in class StatementFlags

CALL .

$ StatementFlags#isReplace — Property in class StatementFlags

REPLACE .

$ StatementFlags#isSelect — Property in class StatementFlags

SELECT .

$ StatementFlags#isShow — Property in class StatementFlags

SHOW .

$ StatementFlags#isSubQuery — Property in class StatementFlags

Contains a subquery.

J

JoinKeyword — Class in namespace PhpMyAdmin\SqlParser\Components

JOIN keyword parser.

JoinKeywords — Class in namespace PhpMyAdmin\SqlParser\Parsers

JOIN keyword parser.

$ DeleteStatement#join — Property in class DeleteStatement
Joins.
$ SelectStatement#join — Property in class SelectStatement
Joins.
$ UpdateStatement#join — Property in class UpdateStatement
Joins.
$ StatementFlags#join — Property in class StatementFlags

K

$ CreateDefinition#key — Property in class CreateDefinition

The key.

Key — Class in namespace PhpMyAdmin\SqlParser\Components

Parses the definition of a key.

$ Context#keywords — Property in class Context

List of keywords.

Keys — Class in namespace PhpMyAdmin\SqlParser\Parsers

Parses the definition of a key.

KillStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

KILL [HARD|SOFT] { {CONNECTION|QUERY} id | QUERY ID query_id | USER user_name }

$ Token#keyword — Property in class Token

The keyword value this token contains, always uppercase.

L

$ Condition#leftOperand — Property in class Condition
$ DataType#lowercase — Property in class DataType
$ IntoKeyword#linesOptions — Property in class IntoKeyword

Options for OPTIONS keyword.

Limit — Class in namespace PhpMyAdmin\SqlParser\Components

LIMIT keyword parser.

LockExpression — Class in namespace PhpMyAdmin\SqlParser\Components

Parses a reference to a LOCK expression.

$ Context#loadedContext — Property in class Context

The name of the loaded context.

Context::load() — Method in class Context

Loads the specified context.

Context::loadClosest() — Method in class Context

Loads the context with the closest version to the one specified.

LexerException — Class in namespace PhpMyAdmin\SqlParser\Exceptions

Exception thrown by the lexer.

Lexer — Class in namespace PhpMyAdmin\SqlParser

Defines the lexer of the library.

$ Lexer#len — Property in class Lexer

The length of $str.

$ Lexer#last — Property in class Lexer

The index of the last parsed character.

$ Lexer#list — Property in class Lexer

Tokens extracted from given strings.

Lexer::lex() — Method in class Lexer

Parses the string and extracts lexemes.

$ Parser#list — Property in class Parser

The list of tokens that are parsed.

Limits — Class in namespace PhpMyAdmin\SqlParser\Parsers

LIMIT keyword parser.

LockExpressions — Class in namespace PhpMyAdmin\SqlParser\Parsers

Parses a reference to a LOCK expression.

$ Statement#last — Property in class Statement

The index of the last token used in this statement.

$ CreateStatement#like — Property in class CreateStatement

If CREATE TABLE ... LIKE.

$ DeleteStatement#limit — Property in class DeleteStatement

Conditions used for limiting the size of the result set.

LoadStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

LOAD statement.

$ LoadStatement#linesOptions — Property in class LoadStatement

Options for OPTIONS keyword.

$ LoadStatement#linesRows — Property in class LoadStatement

LINES/ROWS Keyword.

LockStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

LOCK statement.

$ LockStatement#locked — Property in class LockStatement

Tables with their Lock expressions.

$ PurgeStatement#logType — Property in class PurgeStatement

The type of logs

$ SelectStatement#limit — Property in class SelectStatement

Conditions used for limiting the size of the result set.

$ UpdateStatement#limit — Property in class UpdateStatement

Conditions used for limiting the size of the result set.

$ ContextGenerator#labelsFlags — Property in class ContextGenerator

Labels and flags that may be used when defining keywords.

$ ContextGenerator#links — Property in class ContextGenerator

Documentation links for each context.

Translator::load() — Method in class Translator

Loads translator.

UtfString::length() — Method in class UtfString

Returns the length in characters of the string.

$ FormattingOptions#lineEnding — Property in class FormattingOptions
$ StatementFlags#limit — Property in class StatementFlags

M

OptionsArray::merge() — Method in class OptionsArray

Merges the specified options with these ones. Values with same ID will be replaced.

$ Context#mode — Property in class Context

The mode of the MySQL server that will be used in lexing, parsing and building the statements.

MaintenanceStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

Maintenance statement.

CLI::mergeLongOpts() — Method in class CLI

N

$ CreateDefinition#name — Property in class CreateDefinition

The name of the new column.

$ DataType#name — Property in class DataType

The name of the data type.

$ FunctionCall#name — Property in class FunctionCall

The name of this function.

$ Key#name — Property in class Key

The name of this key.

$ ParameterDefinition#name — Property in class ParameterDefinition

The name of the new column.

$ PartitionDefinition#name — Property in class PartitionDefinition

The name of this partition.

$ RenameOperation#new — Property in class RenameOperation

The new table name.

$ CreateStatement#name — Property in class CreateStatement

The name of the entity that is created.

NotImplementedStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

Not implemented (yet) statements.

O

$ AlterOperation#options — Property in class AlterOperation

Options of this operation.

$ Condition#operator — Property in class Condition
$ CreateDefinition#options — Property in class CreateDefinition

The options of this field.

$ DataType#options — Property in class DataType

The options of this data type.

$ JoinKeyword#on — Property in class JoinKeyword

Join conditions.

$ Key#options — Property in class Key

The options of this key or null if none where found.

$ Limit#offset — Property in class Limit

The number of rows skipped.

OptionsArray — Class in namespace PhpMyAdmin\SqlParser\Components
OrderKeyword — Class in namespace PhpMyAdmin\SqlParser\Components

ORDER BY keyword parser.

$ PartitionDefinition#options — Property in class PartitionDefinition

The options of this field.

$ Reference#options — Property in class Reference

The options of the referencing.

$ RenameOperation#old — Property in class RenameOperation

The old table name.

OptionsArrays — Class in namespace PhpMyAdmin\SqlParser\Parsers

Parses a list of options.

OrderKeywords — Class in namespace PhpMyAdmin\SqlParser\Parsers

ORDER BY keyword parser.

$ Statement#options — Property in class Statement

The options of this query.

$ DeleteStatement#order — Property in class DeleteStatement

Specifies the order of the rows in the result set.

$ InsertStatement#onDuplicateSet — Property in class InsertStatement

If ON DUPLICATE KEY UPDATE clause is present holds the SetOperation.

OptimizeStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

OPTIMIZE statement.

$ SelectStatement#order — Property in class SelectStatement

Specifies the order of the rows in the result set.

$ SetStatement#options — Property in class SetStatement

Options used in current statement.

$ UpdateStatement#order — Property in class UpdateStatement

Specifies the order of the rows in the result set.

TokensList::offsetSet() — Method in class TokensList

Sets a Token inside the list of tokens.

TokensList::offsetGet() — Method in class TokensList

Gets a Token from the list of tokens.

TokensList::offsetExists() — Method in class TokensList

Checks if an offset was previously set.

TokensList::offsetUnset() — Method in class TokensList

Unsets the value of an offset, if the offset exists.

UtfString::offsetExists() — Method in class UtfString

Checks if the given offset exists.

UtfString::offsetGet() — Method in class UtfString

Gets the character at given offset.

UtfString::offsetSet() — Method in class UtfString

Sets the value of a character.

UtfString::offsetUnset() — Method in class UtfString

Unsets an index.

$ BufferedQuery#options — Property in class BufferedQuery

The options of this parser.

$ StatementFlags#offset — Property in class StatementFlags
TODO
$ StatementFlags#order — Property in class StatementFlags

P

$ AlterOperation#partitions — Property in class AlterOperation

The partitions.

$ DataType#parameters — Property in class DataType

The parameters of this data type.

$ FunctionCall#parameters — Property in class FunctionCall

The list of parameters.

IntoKeyword::parseFileOptions() — Method in class IntoKeyword
ParameterDefinition — Class in namespace PhpMyAdmin\SqlParser\Components

The definition of a parameter of a function or procedure.

PartitionDefinition — Class in namespace PhpMyAdmin\SqlParser\Components

Parses the create definition of a partition.

$ PartitionDefinition#partitionOptions — Property in class PartitionDefinition

All field options.

$ LexerException#pos — Property in class LexerException

The index of the character that produced this error.

ParserException — Class in namespace PhpMyAdmin\SqlParser\Exceptions

Exception thrown by the parser.

Lexer::parseKeyword() — Method in class Lexer

Parses a keyword.

Lexer::parseLabel() — Method in class Lexer

Parses a label.

Lexer::parseOperator() — Method in class Lexer

Parses an operator.

Lexer::parseWhitespace() — Method in class Lexer

Parses a whitespace.

Lexer::parseComment() — Method in class Lexer

Parses a comment.

Lexer::parseBool() — Method in class Lexer

Parses a boolean.

Lexer::parseNumber() — Method in class Lexer

Parses a number.

Lexer::parseString() — Method in class Lexer

Parses a string.

Lexer::parseSymbol() — Method in class Lexer

Parses a symbol.

Lexer::parseUnknown() — Method in class Lexer

Parses unknown parts of the query.

Lexer::parseDelimiter() — Method in class Lexer

Parses the delimiter of the query.

Parseable — Class in namespace PhpMyAdmin\SqlParser

Defines a class that offers the parse() static method.

Parseable::parse() — Method in class Parseable

Parses the tokens contained in the given list in the context of the given parser.

Parser — Class in namespace PhpMyAdmin\SqlParser

Defines the parser of the library.

Parser::parse() — Method in class Parser

Builds the parse trees.

AlterOperations::parse() — Method in class AlterOperations
Array2d::parse() — Method in class Array2d
ArrayObjs::parse() — Method in class ArrayObjs
CaseExpressions::parse() — Method in class CaseExpressions
Conditions::parse() — Method in class Conditions
CreateDefinitions::parse() — Method in class CreateDefinitions
DataTypes::parse() — Method in class DataTypes
ExpressionArray::parse() — Method in class ExpressionArray
Expressions::parse() — Method in class Expressions

Possible options:.

FunctionCalls::parse() — Method in class FunctionCalls
GroupKeywords::parse() — Method in class GroupKeywords
IndexHints::parse() — Method in class IndexHints
IntoKeywords::parse() — Method in class IntoKeywords
JoinKeywords::parse() — Method in class JoinKeywords
Keys::parse() — Method in class Keys
Limits::parse() — Method in class Limits
LockExpressions::parse() — Method in class LockExpressions
OptionsArrays::parse() — Method in class OptionsArrays
OrderKeywords::parse() — Method in class OrderKeywords
ParameterDefinitions — Class in namespace PhpMyAdmin\SqlParser\Parsers

The definition of a parameter of a function or procedure.

ParameterDefinitions::parse() — Method in class ParameterDefinitions
PartitionDefinitions — Class in namespace PhpMyAdmin\SqlParser\Parsers

Parses the create definition of a partition.

$ PartitionDefinitions#partitionOptions — Property in class PartitionDefinitions

All field options.

PartitionDefinitions::parse() — Method in class PartitionDefinitions
References::parse() — Method in class References
RenameOperations::parse() — Method in class RenameOperations
SetOperations::parse() — Method in class SetOperations
UnionKeywords::parse() — Method in class UnionKeywords

Parses the tokens contained in the given list in the context of the given parser.

Statement::parse() — Method in class Statement

Parses the statements defined by the tokens list.

AlterStatement::parse() — Method in class AlterStatement
$ CreateStatement#partitionBy — Property in class CreateStatement

Expression used for partitioning.

$ CreateStatement#partitionsNum — Property in class CreateStatement

The number of partitions.

$ CreateStatement#partitions — Property in class CreateStatement

The partition of the new table.

$ CreateStatement#parameters — Property in class CreateStatement

The parameters of this routine.

CreateStatement::parse() — Method in class CreateStatement
$ DeleteStatement#partition — Property in class DeleteStatement

Partitions used as source for this statement.

DeleteStatement::parse() — Method in class DeleteStatement
ExplainStatement::parse() — Method in class ExplainStatement
InsertStatement::parse() — Method in class InsertStatement
$ KillStatement#parenthesisUsed — Property in class KillStatement

Whether parenthesis used around the identifier or not

KillStatement::parse() — Method in class KillStatement
$ LoadStatement#partition — Property in class LoadStatement

Partitions used as source for this statement.

LoadStatement::parse() — Method in class LoadStatement
LoadStatement::parseFileOptions() — Method in class LoadStatement
LoadStatement::parseKeywordsAccordingToState() — Method in class LoadStatement
LockStatement::parse() — Method in class LockStatement
NotImplementedStatement::parse() — Method in class NotImplementedStatement
PurgeStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

PURGE statement.

PurgeStatement::parse() — Method in class PurgeStatement
ReplaceStatement::parse() — Method in class ReplaceStatement
$ SelectStatement#partition — Property in class SelectStatement

Partitions used as source for this statement.

$ SelectStatement#procedure — Property in class SelectStatement

Procedure that should process the data in the result set.

SelectStatement::parse() — Method in class SelectStatement

Parses the statements defined by the tokens list.

TransactionStatement::parse() — Method in class TransactionStatement
WithStatement::parse() — Method in class WithStatement
$ Token#position — Property in class Token

The position in the initial string where this token started.

ContextGenerator::printWords() — Method in class ContextGenerator

Prints an array of a words in PHP format.

CLI::parseHighlight() — Method in class CLI
CLI::parseLint() — Method in class CLI
CLI::parseTokenize() — Method in class CLI

Q

$ BufferedQuery#query — Property in class BufferedQuery

The query that is being processed.

Query — Class in namespace PhpMyAdmin\SqlParser\Utils

Statement utilities.

$ StatementFlags#queryType — Property in class StatementFlags

The type of the statement (which is usually the first keyword).

R

$ ArrayObj#raw — Property in class ArrayObj

The array that contains the unprocessed value of each token.

$ CaseExpression#results — Property in class CaseExpression

The results matching with the WHEN clauses.

$ Condition#rightOperand — Property in class Condition
$ CreateDefinition#references — Property in class CreateDefinition

The table that is referenced.

$ Limit#rowCount — Property in class Limit

The number of rows to be returned.

OptionsArray::remove() — Method in class OptionsArray

Removes the option from the array.

Reference — Class in namespace PhpMyAdmin\SqlParser\Components

REFERENCES keyword parser.

RenameOperation — Class in namespace PhpMyAdmin\SqlParser\Components

RENAME TABLE keyword parser.

References — Class in namespace PhpMyAdmin\SqlParser\Parsers

REFERENCES keyword parser.

RenameOperations — Class in namespace PhpMyAdmin\SqlParser\Parsers

RENAME TABLE keyword parser.

$ CreateStatement#return — Property in class CreateStatement

The return data type of this routine.

$ LoadStatement#replaceIgnore — Property in class LoadStatement

REPLACE/IGNORE Keyword.

RenameStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

RENAME statement.

$ RenameStatement#renames — Property in class RenameStatement

The old and new names of the tables.

RepairStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

REPAIR statement.

ReplaceStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

REPLACE statement.

RestoreStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

RESTORE statement.

ContextGenerator::readWords() — Method in class ContextGenerator

Reads a list of words and sorts it by type, length and keyword.

CLI::run() — Method in class CLI
CLI::runHighlight() — Method in class CLI
CLI::runLint() — Method in class CLI
CLI::runTokenize() — Method in class CLI
CLI::readStdin() — Method in class CLI
Query::replaceClause() — Method in class Query

Builds a query by rebuilding the statement from the tokens list supplied and replaces a clause.

Query::replaceClauses() — Method in class Query

Builds a query by rebuilding the statement from the tokens list supplied and replaces multiple clauses.

$ StatementFlags#reload — Property in class StatementFlags

Whether a page reload is required.

S

$ Expression#subquery — Property in class Expression

The type of subquery.

$ PartitionDefinition#subpartitions — Property in class PartitionDefinition

The subpartitions of this partition.

SetOperation — Class in namespace PhpMyAdmin\SqlParser\Components
$ WithKeyword#statement — Property in class WithKeyword
Context::setMode() — Method in class Context

Sets the SQL mode.

$ Lexer#str — Property in class Lexer

The string to be parsed.

Lexer::setDelimiter() — Method in class Lexer

Sets the delimiter.

$ Parser#statements — Property in class Parser

List of statements parsed.

SetOperations — Class in namespace PhpMyAdmin\SqlParser\Parsers

SET keyword parser.

Statement — Class in namespace PhpMyAdmin\SqlParser

The result of the parser is an array of statements are extensions of the class defined here.

$ Statement#statementOptions — Property in class Statement

Options for this statement.

$ AlterStatement#statementOptions — Property in class AlterStatement

Options of this statement.

$ AnalyzeStatement#statementOptions — Property in class AnalyzeStatement

Options of this statement.

$ BackupStatement#statementOptions — Property in class BackupStatement

Options of this statement.

$ CheckStatement#statementOptions — Property in class CheckStatement

Options of this statement.

$ ChecksumStatement#statementOptions — Property in class ChecksumStatement

Options of this statement.

$ CreateStatement#statementOptions — Property in class CreateStatement

Options for CREATE statements.

$ CreateStatement#select — Property in class CreateStatement

If CREATE TABLE ... SELECT.

$ CreateStatement#subpartitionBy — Property in class CreateStatement

Expression used for subpartitioning.

$ CreateStatement#subpartitionsNum — Property in class CreateStatement

The number of subpartitions.

$ DeleteStatement#statementOptions — Property in class DeleteStatement

Options for DELETE statements.

$ DropStatement#statementOptions — Property in class DropStatement

Options of this statement.

$ ExplainStatement#statementAlias — Property in class ExplainStatement

The statement alias, could be any of the following:

  • {EXPLAIN | DESCRIBE | DESC}
  • {EXPLAIN | DESCRIBE | DESC} ANALYZE
  • ANALYZE
$ InsertStatement#statementOptions — Property in class InsertStatement

Options for INSERT statements.

$ InsertStatement#set — Property in class InsertStatement

If SET clause is present holds the SetOperation.

$ InsertStatement#select — Property in class InsertStatement

If SELECT clause is present holds the SelectStatement.

$ KillStatement#statementOptions — Property in class KillStatement

Options of this statement.

$ LoadStatement#statementOptions — Property in class LoadStatement

Options for LOAD statements and their slot ID.

$ LoadStatement#set — Property in class LoadStatement

SET clause's updated values(optional).

$ OptimizeStatement#statementOptions — Property in class OptimizeStatement

Options of this statement.

$ RepairStatement#statementOptions — Property in class RepairStatement

Options of this statement.

$ ReplaceStatement#statementOptions — Property in class ReplaceStatement

Options for REPLACE statements and their slot ID.

$ ReplaceStatement#set — Property in class ReplaceStatement

If SET clause is present holds the SetOperation.

$ ReplaceStatement#select — Property in class ReplaceStatement

If SELECT clause is present holds the SelectStatement.

$ RestoreStatement#statementOptions — Property in class RestoreStatement

Options of this statement.

SelectStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

SELECT statement.

$ SelectStatement#statementOptions — Property in class SelectStatement

Options for SELECT statements and their slot ID.

SetStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

SET statement.

$ SetStatement#statementOptions — Property in class SetStatement

Possible exceptions in SET statement.

$ SetStatement#set — Property in class SetStatement

The updated values.

ShowStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

SHOW statement.

$ ShowStatement#statementOptions — Property in class ShowStatement

Options of this statement.

$ TransactionStatement#statements — Property in class TransactionStatement

The list of statements in this transaction.

$ TransactionStatement#statementOptions — Property in class TransactionStatement

Options for this query.

$ TruncateStatement#statementOptions — Property in class TruncateStatement

Options for TRUNCATE statements.

$ UpdateStatement#statementOptions — Property in class UpdateStatement

Options for UPDATE statements and their slot ID.

$ UpdateStatement#set — Property in class UpdateStatement

The updated values.

$ WithStatement#statementOptions — Property in class WithStatement

Options for WITH statements and their slot ID.

ContextGenerator::sortWords() — Method in class ContextGenerator

Sorts an array of words.

Translator::setLocale() — Method in class Translator
$ BufferedQuery#status — Property in class BufferedQuery

The current status of the parser.

BufferedQuery::setDelimiter() — Method in class BufferedQuery

Sets the delimiter.

$ Formatter#shortClauses — Property in class Formatter

Clauses that are usually short.

StatementFlags — Class in namespace PhpMyAdmin\SqlParser\Utils
$ StatementFlags#selectFrom — Property in class StatementFlags

SELECT ... FROM .

StatementInfo — Class in namespace PhpMyAdmin\SqlParser\Utils

T

$ CreateDefinition#type — Property in class CreateDefinition

The data type of thew new column.

$ Expression#table — Property in class Expression

The name of this table.

$ GroupKeyword#type — Property in class GroupKeyword
$ IntoKeyword#type — Property in class IntoKeyword

Type of target (OUTFILE or SYMBOL).

$ JoinKeyword#type — Property in class JoinKeyword

Type of this join.

$ Key#type — Property in class Key

The type of this key.

$ LockExpression#table — Property in class LockExpression

The table to be locked.

$ LockExpression#type — Property in class LockExpression

The type of lock to be applied.

$ OrderKeyword#type — Property in class OrderKeyword

The order type.

$ ParameterDefinition#type — Property in class ParameterDefinition

The data type of thew new column.

$ PartitionDefinition#type — Property in class PartitionDefinition

The type of this partition (what follows the VALUES keyword).

$ Reference#table — Property in class Reference

The referenced table.

$ ParserException#token — Property in class ParserException

The token that produced this error.

$ AlterStatement#table — Property in class AlterStatement

Table affected.

$ AnalyzeStatement#tables — Property in class AnalyzeStatement

Analyzed tables.

$ CreateStatement#table — Property in class CreateStatement

If CREATE TRIGGER the name of the table.

$ DropStatement#table — Property in class DropStatement

Table of the dropped index.

$ LoadStatement#table — Property in class LoadStatement

Table used as destination for this statement.

$ MaintenanceStatement#tables — Property in class MaintenanceStatement

Tables maintained.

$ OptimizeStatement#tables — Property in class OptimizeStatement

Optimized tables.

TransactionStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

Transaction statement.

$ TransactionStatement#type — Property in class TransactionStatement

The type of this query.

TruncateStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

TRUNCATE statement.

$ TruncateStatement#table — Property in class TruncateStatement

The name of the truncated table.

$ UpdateStatement#tables — Property in class UpdateStatement

Tables used as sources for this statement.

Token — Class in namespace PhpMyAdmin\SqlParser

Defines a token along with a set of types and flags and utility functions.

$ Token#token — Property in class Token

The token it its raw string representation.

$ Token#type — Property in class Token

The type of this token.

TokensList — Class in namespace PhpMyAdmin\SqlParser

Defines an array of tokens and utility functions to iterate through it.

TestGenerator — Class in namespace PhpMyAdmin\SqlParser\Tools

Used for test generation.

Translator — Class in namespace PhpMyAdmin\SqlParser

Defines the localization helper infrastructure of the library.

Formatter::toString() — Method in class Formatter

Tries to print the query and returns the result.

Table — Class in namespace PhpMyAdmin\SqlParser\Utils

Table utilities.

U

$ JoinKeyword#using — Property in class JoinKeyword

Columns in Using clause.

UnionKeywords — Class in namespace PhpMyAdmin\SqlParser\Parsers

UNION keyword builder.

$ DeleteStatement#using — Property in class DeleteStatement

Tables used as sources for this statement.

$ NotImplementedStatement#unknown — Property in class NotImplementedStatement

The part of the statement that can't be parsed.

$ SelectStatement#union — Property in class SelectStatement
Unions.
UpdateStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

UPDATE statement.

UtfString — Class in namespace PhpMyAdmin\SqlParser

Implementation for UTF-8 strings.

CLI::usageHighlight() — Method in class CLI
CLI::usageLint() — Method in class CLI
CLI::usageTokenize() — Method in class CLI
$ StatementFlags#union — Property in class StatementFlags

V

$ ArrayObj#values — Property in class ArrayObj

The array that contains the processed value of each token.

$ CaseExpression#value — Property in class CaseExpression

The value to be compared.

$ IntoKeyword#values — Property in class IntoKeyword

The values to be selected into (SELECT .. INTO @var1).

$ SetOperation#value — Property in class SetOperation

The new value.

Statement::validateClauseOrder() — Method in class Statement

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

$ InsertStatement#values — Property in class InsertStatement

Values to be inserted.

$ ReplaceStatement#values — Property in class ReplaceStatement

Values to be replaced.

$ Token#value — Property in class Token

The value this token contains (i.e. token after some evaluation).

W

WithKeyword — Class in namespace PhpMyAdmin\SqlParser\Components

WITH keyword builder.

$ CreateStatement#with — Property in class CreateStatement

If CREATE TABLE WITH.

$ DeleteStatement#where — Property in class DeleteStatement

Conditions used for filtering each row of the result set.

$ InsertStatement#with — Property in class InsertStatement

If WITH CTE is present holds the WithStatement.

$ SelectStatement#where — Property in class SelectStatement

Conditions used for filtering each row of the result set.

$ UpdateStatement#where — Property in class UpdateStatement

Conditions used for filtering each row of the result set.

WithStatement — Class in namespace PhpMyAdmin\SqlParser\Statements

WITH statement.

$ WithStatement#withers — Property in class WithStatement

_

AlterOperation::__construct() — Method in class AlterOperation
AlterOperation::__toString() — Method in class AlterOperation
ArrayObj::__construct() — Method in class ArrayObj
ArrayObj::__toString() — Method in class ArrayObj
CaseExpression::__toString() — Method in class CaseExpression
Condition::__construct() — Method in class Condition
Condition::__toString() — Method in class Condition
CreateDefinition::__construct() — Method in class CreateDefinition
CreateDefinition::__toString() — Method in class CreateDefinition
DataType::__construct() — Method in class DataType
DataType::__toString() — Method in class DataType
Expression::__construct() — Method in class Expression

Syntax: new Expression('expr') new Expression('expr', 'alias') new Expression('database', 'table', 'column') new Expression('database', 'table', 'column', 'alias')

Expression::__toString() — Method in class Expression
FunctionCall::__construct() — Method in class FunctionCall
FunctionCall::__toString() — Method in class FunctionCall
GroupKeyword::__construct() — Method in class GroupKeyword
GroupKeyword::__toString() — Method in class GroupKeyword
IndexHint::__construct() — Method in class IndexHint
IndexHint::__toString() — Method in class IndexHint
IntoKeyword::__construct() — Method in class IntoKeyword
IntoKeyword::__toString() — Method in class IntoKeyword
JoinKeyword::__construct() — Method in class JoinKeyword
JoinKeyword::__toString() — Method in class JoinKeyword
Key::__construct() — Method in class Key
Key::__toString() — Method in class Key
Limit::__construct() — Method in class Limit
Limit::__toString() — Method in class Limit
LockExpression::__toString() — Method in class LockExpression
OptionsArray::__construct() — Method in class OptionsArray
OptionsArray::__toString() — Method in class OptionsArray
OrderKeyword::__construct() — Method in class OrderKeyword
OrderKeyword::__toString() — Method in class OrderKeyword
ParameterDefinition::__construct() — Method in class ParameterDefinition
ParameterDefinition::__toString() — Method in class ParameterDefinition
PartitionDefinition::__toString() — Method in class PartitionDefinition
Reference::__construct() — Method in class Reference
Reference::__toString() — Method in class Reference
RenameOperation::__construct() — Method in class RenameOperation
RenameOperation::__toString() — Method in class RenameOperation
SetOperation::__construct() — Method in class SetOperation
SetOperation::__toString() — Method in class SetOperation
WithKeyword::__construct() — Method in class WithKeyword
WithKeyword::__toString() — Method in class WithKeyword
LexerException::__construct() — Method in class LexerException
ParserException::__construct() — Method in class ParserException
Lexer::__construct() — Method in class Lexer
Parser::__construct() — Method in class Parser
Statement::__construct() — Method in class Statement
Statement::__toString() — Method in class Statement

Builds the string representation of this statement.

Token::__construct() — Method in class Token
TokensList::__construct() — Method in class TokensList
UtfString::__construct() — Method in class UtfString
UtfString::__toString() — Method in class UtfString

Returns the contained string.

BufferedQuery::__construct() — Method in class BufferedQuery
CLI::__construct() — Method in class CLI
ForeignKey::__construct() — Method in class ForeignKey
Formatter::__construct() — Method in class Formatter
FormattingOptions::__construct() — Method in class FormattingOptions
StatementInfo::__construct() — Method in class StatementInfo