A

AlterOperationClass in namespace PhpMyAdmin\SqlParser\Components

Parses an alter operation.

Array2dClass in namespace PhpMyAdmin\SqlParser\Components

VALUES keyword parser.

ArrayObjClass in namespace PhpMyAdmin\SqlParser\Components

Parses an array.

$ CaseExpression#aliasProperty in class CaseExpression

The alias of this CASE statement.

$ Condition#ALLOWED_KEYWORDSProperty in class Condition

List of allowed reserved keywords in conditions.

$ Expression#aliasProperty in class Expression

The alias of this expression.

Statement::after() — Method in class Statement

Function called after the token was processed.

AlterStatementClass in namespace PhpMyAdmin\SqlParser\Statements

ALTER statement.

$ AlterStatement#alteredProperty in class AlterStatement

Column affected by this statement.

AnalyzeStatementClass in namespace PhpMyAdmin\SqlParser\Statements

ANALYZE statement.

MaintenanceStatement::after() — Method in class MaintenanceStatement

Function called after the token was processed.

TokensList::add() — Method in class TokensList

Adds a new token.

$ Query#ALLFLAGSProperty in class Query

B

Component::build() — Method in class Component

Builds the string representation of a component of this type.

AlterOperation::build() — Method in class AlterOperation
Array2d::build() — Method in class Array2d
ArrayObj::build() — Method in class ArrayObj
CaseExpression::build() — Method in class CaseExpression
Condition::build() — Method in class Condition
CreateDefinition::build() — Method in class CreateDefinition
DataType::build() — Method in class DataType
Expression::build() — Method in class Expression
ExpressionArray::build() — Method in class ExpressionArray
FunctionCall::build() — Method in class FunctionCall
GroupKeyword::build() — Method in class GroupKeyword
IndexHint::build() — Method in class IndexHint
IntoKeyword::build() — Method in class IntoKeyword
JoinKeyword::build() — Method in class JoinKeyword
Key::build() — Method in class Key
Limit::build() — Method in class Limit
LockExpression::build() — Method in class LockExpression
OptionsArray::build() — Method in class OptionsArray
OrderKeyword::build() — Method in class OrderKeyword
ParameterDefinition::build() — Method in class ParameterDefinition
PartitionDefinition::build() — Method in class PartitionDefinition
Reference::build() — Method in class Reference
RenameOperation::build() — Method in class RenameOperation
SetOperation::build() — Method in class SetOperation
UnionKeyword::build() — Method in class UnionKeyword
WithKeyword::build() — Method in class WithKeyword
$ Parser#bracketsProperty in class Parser

The number of opened brackets.

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
BackupStatementClass in namespace PhpMyAdmin\SqlParser\Statements

BACKUP statement.

CallStatement::build() — Method in class CallStatement

Build statement for CALL.

$ CreateStatement#bodyProperty in class CreateStatement

The body of this function or procedure.

CreateStatement::build() — Method in class CreateStatement
DeleteStatement::build() — Method in class DeleteStatement
InsertStatement::build() — Method in class InsertStatement
LoadStatement::build() — Method in class LoadStatement
LockStatement::build() — Method in class LockStatement
NotImplementedStatement::build() — Method in class NotImplementedStatement
PurgeStatement::build() — Method in class PurgeStatement
RenameStatement::before() — Method in class RenameStatement

Function called before the token is processed.

RenameStatement::build() — Method in class RenameStatement
ReplaceStatement::build() — Method in class ReplaceStatement
SetStatement::build() — Method in class SetStatement
TransactionStatement::build() — Method in class TransactionStatement
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.

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.

$ UtfString#byteIdxProperty in class UtfString

The index of current byte.

$ UtfString#byteLenProperty in class UtfString

The length of the string (in bytes).

BufferedQueryClass in namespace PhpMyAdmin\SqlParser\Utils

Buffer query utilities.

C

ComponentClass in namespace PhpMyAdmin\SqlParser

A component (of a statement) is a part of a statement that is common to multiple query types.

CaseExpressionClass in namespace PhpMyAdmin\SqlParser\Components

Parses a reference to a CASE expression.

$ CaseExpression#conditionsProperty in class CaseExpression

The conditions in WHEN clauses.

$ CaseExpression#compare_valuesProperty in class CaseExpression

The values to be compared against.

ConditionClass in namespace PhpMyAdmin\SqlParser\Components

WHERE keyword parser.

CreateDefinitionClass in namespace PhpMyAdmin\SqlParser\Components

Parses the create definition of a column or a key.

$ Expression#columnProperty in class Expression

The name of the column.

$ IntoKeyword#columnsProperty in class IntoKeyword

The name of the columns.

$ Key#columnsProperty in class Key

Columns.

$ Reference#columnsProperty in class Reference

The referenced columns.

$ SetOperation#columnProperty in class SetOperation

The name of the column that is being updated.

$ WithKeyword#columnsProperty in class WithKeyword
ContextClass in namespace PhpMyAdmin\SqlParser

Holds the configuration of the context that is currently used.

$ Context#contextPrefixProperty in class Context

The prefix concatenated to the context name when an incomplete class name is specified.

ContextMariaDb100000Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 10.0.

ContextMariaDb100100Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 10.1.

ContextMariaDb100200Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 10.2.

ContextMariaDb100300Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MariaDB 10.3.

ContextMySql50000Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 5.0.

ContextMySql50100Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 5.1.

ContextMySql50500Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 5.5.

ContextMySql50600Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 5.6.

ContextMySql50700Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 5.7.

ContextMySql80000Class in namespace PhpMyAdmin\SqlParser\Contexts

Context for MySQL 8.0.

CoreClass in namespace PhpMyAdmin\SqlParser
$ LexerException#chProperty in class LexerException

The character that produced this error.

$ Statement#CLAUSESProperty in class Statement

The clauses of this statement, in order.

CallStatementClass in namespace PhpMyAdmin\SqlParser\Statements

CALL statement.

$ CallStatement#callProperty in class CallStatement

The name of the function and its parameters.

CheckStatementClass in namespace PhpMyAdmin\SqlParser\Statements

CHECK statement.

ChecksumStatementClass in namespace PhpMyAdmin\SqlParser\Statements

CHECKSUM statement.

CreateStatementClass in namespace PhpMyAdmin\SqlParser\Statements

CREATE statement.

$ DeleteStatement#CLAUSESProperty in class DeleteStatement

The clauses of this statement, in order.

$ DeleteStatement#columnsProperty in class DeleteStatement

Columns used in this statement.

$ DropStatement#CLAUSESProperty in class DropStatement

The clauses of this statement, in order.

$ LoadStatement#charset_nameProperty in class LoadStatement

Character set used in this statement.

$ LoadStatement#col_name_or_user_varProperty in class LoadStatement

Column names or user variables.

$ SelectStatement#CLAUSESProperty in class SelectStatement

The clauses of this statement, in order.

$ SetStatement#CLAUSESProperty in class SetStatement

The clauses of this statement, in order.

$ UpdateStatement#CLAUSESProperty in class UpdateStatement

The clauses of this statement, in order.

$ WithStatement#CLAUSESProperty in class WithStatement

The clauses of this statement, in order.

$ TokensList#countProperty in class TokensList

The count of tokens.

ContextGeneratorClass in namespace PhpMyAdmin\SqlParser\Tools

Used for context generation.

$ UtfString#charIdxProperty in class UtfString

The index of current character.

$ UtfString#charLenProperty in class UtfString

The length of the string (in characters).

$ BufferedQuery#currentProperty in class BufferedQuery

The last incomplete query that was extracted.

CLIClass in namespace PhpMyAdmin\SqlParser\Utils

CLI interface.

D

$ AlterOperation#DB_OPTIONSProperty in class AlterOperation

All database options.

$ Condition#DELIMITERSProperty in class Condition

Logical operators that can be used to delimit expressions.

DataTypeClass in namespace PhpMyAdmin\SqlParser\Components

Parses a data type.

$ DataType#DATA_TYPE_OPTIONSProperty in class DataType

All data type options.

$ Expression#databaseProperty in class Expression

The name of this database.

$ IntoKeyword#destProperty in class IntoKeyword

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

$ Context#defaultContextProperty in class Context

The name of the default content.

$ Lexer#DEFAULT_DELIMITERProperty in class Lexer

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

$ Lexer#delimiterProperty in class Lexer

Statements delimiter.

$ Lexer#delimiterLenProperty in class Lexer

The length of the delimiter.

$ CreateStatement#DB_OPTIONSProperty in class CreateStatement

All database options.

DeleteStatementClass in namespace PhpMyAdmin\SqlParser\Statements

DELETE statement.

DropStatementClass in namespace PhpMyAdmin\SqlParser\Statements

DROP statement.

$ BufferedQuery#delimiterProperty in class BufferedQuery

The last delimiter used.

$ BufferedQuery#delimiterLenProperty in class BufferedQuery

The length of the delimiter.

E

$ CaseExpression#else_resultProperty in class CaseExpression

The result in ELSE section of expr.

$ CaseExpression#exprProperty in class CaseExpression

The sub-expression.

$ Condition#exprProperty in class Condition

The condition.

ExpressionClass in namespace PhpMyAdmin\SqlParser\Components

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

$ Expression#exprProperty in class Expression

The sub-expression.

ExpressionArrayClass in namespace PhpMyAdmin\SqlParser\Components

Parses a list of expressions delimited by a comma.

$ GroupKeyword#exprProperty in class GroupKeyword

The expression that is used for grouping.

$ JoinKeyword#exprProperty in class JoinKeyword

Join expression.

$ OrderKeyword#exprProperty in class OrderKeyword

The expression that is used for ordering.

$ PartitionDefinition#exprProperty in class PartitionDefinition

The expression used to defined this partition.

Context::escape() — Method in class Context

Escapes the symbol by adding surrounding backticks.

$ Core#errorsProperty in class Core

List of errors that occurred during lexing.

Core::error() — Method in class Core

Creates a new error log.

Lexer::error() — Method in class Lexer

Creates a new error log.

Parser::error() — Method in class Parser

Creates a new error log.

$ Statement#END_OPTIONSProperty in class Statement
$ CreateStatement#entityOptionsProperty in class CreateStatement

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

ExplainStatementClass in namespace PhpMyAdmin\SqlParser\Statements

EXPLAIN statement.

$ PurgeStatement#end_optionProperty in class PurgeStatement

The end option of this query.

$ PurgeStatement#end_exprProperty in class PurgeStatement

The end expr of this query.

$ SelectStatement#END_OPTIONSProperty in class SelectStatement
$ SelectStatement#exprProperty in class SelectStatement

Expressions that are being selected by this statement.

$ SelectStatement#end_optionsProperty in class SelectStatement

The end options of this query.

$ SetStatement#END_OPTIONSProperty in class SetStatement
$ SetStatement#end_optionsProperty in class SetStatement

The end options of this query.

$ TransactionStatement#endProperty in class TransactionStatement

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

Token::extract() — Method in class Token

Does little processing to the token to extract a value.

BufferedQuery::extract() — Method in class BufferedQuery

Extracts a statement from the buffer.

ErrorClass in namespace PhpMyAdmin\SqlParser\Utils

Error related utilities.

Formatter::escapeConsole() — Method in class Formatter

F

$ AlterOperation#fieldProperty in class AlterOperation

The altered field.

$ CreateDefinition#FIELD_OPTIONSProperty in class CreateDefinition

All field options.

$ Expression#functionProperty in class Expression

The name of the function.

FunctionCallClass in namespace PhpMyAdmin\SqlParser\Components

Parses a function call.

$ IndexHint#forProperty in class IndexHint

The clause for which this hint is (JOIN/ORDER BY/GROUP BY)

$ IntoKeyword#FIELDS_OPTIONSProperty in class IntoKeyword

FIELDS/COLUMNS Options for SELECT...INTO statements.

$ IntoKeyword#fields_optionsProperty in class IntoKeyword

Options for FIELDS/COLUMNS keyword.

$ IntoKeyword#fields_keywordProperty in class IntoKeyword

Whether to use FIELDS or COLUMNS while building.

$ Statement#firstProperty in class Statement

The index of the first token used in this statement.

$ CreateStatement#FUNC_OPTIONSProperty in class CreateStatement

All function options.

$ CreateStatement#fieldsProperty in class CreateStatement

If CREATE TABLE, a list of columns and keys.

$ DeleteStatement#fromProperty in class DeleteStatement

Table(s) used as sources for this statement.

$ DropStatement#fieldsProperty in class DropStatement

Dropped elements.

$ LoadStatement#FIELDS_OPTIONSProperty in class LoadStatement

FIELDS/COLUMNS Options for LOAD DATA...INFILE statements.

$ LoadStatement#file_nameProperty in class LoadStatement

File name being used to load data.

$ LoadStatement#fields_optionsProperty in class LoadStatement

Options for FIELDS/COLUMNS keyword.

$ LoadStatement#fields_keywordProperty in class LoadStatement

Whether to use FIELDS or COLUMNS while building.

$ SelectStatement#fromProperty in class SelectStatement

Tables used as sources for this statement.

$ Token#flagsProperty 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.

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

$ Query#FUNCTIONSProperty in class Query

Functions that set the flag is_func.

G

GroupKeywordClass in namespace PhpMyAdmin\SqlParser\Components

GROUP BY keyword parser.

Context::getIdentifierQuote() — Method in class Context

Returns char used to quote identifiers based on currently set SQL Mode (ie. standard or ANSI_QUOTES)

Lexer::getTokens() — Method in class Lexer

Gets the tokens list parsed by a new instance of a lexer.

Statement::getClauses() — Method in class Statement

Gets the clauses of this statement.

$ SelectStatement#groupProperty in class SelectStatement

Conditions used for grouping the result set.

SelectStatement::getClauses() — Method in class SelectStatement

Gets the clauses of this statement.

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::getNextOfType() — Method in class TokensList

Gets the next token.

TokensList::getNextOfTypeAndValue() — 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.

UtfString::getCharLength() — Method in class UtfString

Gets the length of an UTF-8 character.

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

Gets the errors of a lexer and a parser.

Formatter::getDefaultOptions() — Method in class Formatter

The default formatting options.

Formatter::getDefaultFormats() — Method in class Formatter

The styles used for HTML formatting.

Formatter::getGroupLength() — Method in class Formatter

Computes the length of a group.

Misc::getAliases() — Method in class Misc

Gets a list of all aliases and their original names.

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.

Routine::getReturnType() — Method in class Routine

Parses a parameter of a routine.

Routine::getParameter() — Method in class Routine

Parses a parameter of a routine.

Routine::getParameters() — Method in class Routine

Gets the parameters of a routine from the parse tree.

Table::getForeignKeys() — Method in class Table

Gets the foreign keys of the table.

Table::getFields() — Method in class Table

Gets fields of the table.

H

OptionsArray::has() — Method in class OptionsArray

Checks if it has the specified option and returns it value or true.

Context::hasMode() — Method in class Context

Function verifies that given SQL Mode constant is currently set

$ SelectStatement#havingProperty in class SelectStatement

Conditions used for filtering the result set.

I

$ Condition#identifiersProperty in class Condition

Identifiers recognized.

$ Condition#isOperatorProperty in class Condition

Whether this component is an operator.

$ CreateDefinition#isConstraintProperty in class CreateDefinition

Whether this field is a constraint or not.

IndexHintClass in namespace PhpMyAdmin\SqlParser\Components

Parses an Index hint.

$ IndexHint#indexOrKeyProperty in class IndexHint

What the hint is for (INDEX/KEY)

$ IndexHint#indexesProperty in class IndexHint

List of indexes in this hint

IntoKeywordClass in namespace PhpMyAdmin\SqlParser\Components

INTO keyword parser.

OptionsArray::isEmpty() — Method in class OptionsArray

Checks tf there are no options set.

$ ParameterDefinition#inOutProperty in class ParameterDefinition

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

$ PartitionDefinition#isSubpartitionProperty 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.

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.

InsertStatementClass in namespace PhpMyAdmin\SqlParser\Statements

INSERT statement.

$ InsertStatement#intoProperty in class InsertStatement

Tables used as target for this statement.

$ LoadStatement#ignore_numberProperty in class LoadStatement

Ignore 'number' LINES/ROWS.

$ LockStatement#isLockProperty in class LockStatement

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

$ ReplaceStatement#intoProperty in class ReplaceStatement

Tables used as target for this statement.

$ SelectStatement#index_hintsProperty in class SelectStatement

Index hints

$ SelectStatement#intoProperty in class SelectStatement

Destination of this result set.

$ TokensList#idxProperty in class TokensList

The index of the next token to be returned.

$ Formatter#INLINE_CLAUSESProperty 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.

J

JoinKeywordClass in namespace PhpMyAdmin\SqlParser\Components

JOIN keyword parser.

$ JoinKeyword#JOINSProperty in class JoinKeyword

Types of join.

$ DeleteStatement#joinProperty in class DeleteStatement

Joins.

$ SelectStatement#joinProperty in class SelectStatement

Joins.

K

$ CreateDefinition#keyProperty in class CreateDefinition

The key.

KeyClass in namespace PhpMyAdmin\SqlParser\Components

Parses the definition of a key.

$ Key#KEY_OPTIONSProperty in class Key

All key options.

$ Context#KEYWORDSProperty in class Context

List of keywords.

$ ContextMariaDb100000#KEYWORDSProperty in class ContextMariaDb100000

List of keywords.

$ ContextMariaDb100100#KEYWORDSProperty in class ContextMariaDb100100

List of keywords.

$ ContextMariaDb100200#KEYWORDSProperty in class ContextMariaDb100200

List of keywords.

$ ContextMariaDb100300#KEYWORDSProperty in class ContextMariaDb100300

List of keywords.

$ ContextMySql50000#KEYWORDSProperty in class ContextMySql50000

List of keywords.

$ ContextMySql50100#KEYWORDSProperty in class ContextMySql50100

List of keywords.

$ ContextMySql50500#KEYWORDSProperty in class ContextMySql50500

List of keywords.

$ ContextMySql50600#KEYWORDSProperty in class ContextMySql50600

List of keywords.

$ ContextMySql50700#KEYWORDSProperty in class ContextMySql50700

List of keywords.

$ ContextMySql80000#KEYWORDSProperty in class ContextMySql80000

List of keywords.

$ Parser#KEYWORD_PARSERSProperty in class Parser

Array of classes that are used in parsing SQL components.

$ Token#keywordProperty in class Token

The keyword value this token contains, always uppercase.

L

$ IntoKeyword#LINES_OPTIONSProperty in class IntoKeyword

LINES Options for SELECT...INTO statements.

$ IntoKeyword#lines_optionsProperty in class IntoKeyword

Options for OPTIONS keyword.

LimitClass in namespace PhpMyAdmin\SqlParser\Components

LIMIT keyword parser.

LockExpressionClass in namespace PhpMyAdmin\SqlParser\Components

Parses a reference to a LOCK expression.

$ Context#loadedContextProperty 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.

LexerExceptionClass in namespace PhpMyAdmin\SqlParser\Exceptions

Exception thrown by the lexer.

LoaderExceptionClass in namespace PhpMyAdmin\SqlParser\Exceptions

Exception thrown by the lexer.

LexerClass in namespace PhpMyAdmin\SqlParser

Performs lexical analysis over a SQL statement and splits it in multiple tokens.

$ Lexer#lenProperty in class Lexer

The length of $str.

$ Lexer#lastProperty in class Lexer

The index of the last parsed character.

$ Lexer#listProperty in class Lexer

Tokens extracted from given strings.

Lexer::lex() — Method in class Lexer

Parses the string and extracts lexemes.

$ Parser#listProperty in class Parser

The list of tokens that are parsed.

$ Statement#lastProperty in class Statement

The index of the last token used in this statement.

$ CreateStatement#likeProperty in class CreateStatement

If CREATE TABLE ... LIKE.

$ DeleteStatement#limitProperty in class DeleteStatement

Conditions used for limiting the size of the result set.

LoadStatementClass in namespace PhpMyAdmin\SqlParser\Statements

LOAD statement.

$ LoadStatement#LINES_OPTIONSProperty in class LoadStatement

LINES Options for LOAD DATA...INFILE statements.

$ LoadStatement#lines_optionsProperty in class LoadStatement

Options for OPTIONS keyword.

$ LoadStatement#lines_rowsProperty in class LoadStatement

LINES/ROWS Keyword.

LockStatementClass in namespace PhpMyAdmin\SqlParser\Statements

LOCK statement.

$ LockStatement#lockedProperty in class LockStatement

Tables with their Lock expressions.

$ PurgeStatement#log_typeProperty in class PurgeStatement

The type of logs

$ SelectStatement#limitProperty in class SelectStatement

Conditions used for limiting the size of the result set.

$ UpdateStatement#limitProperty in class UpdateStatement

Conditions used for limiting the size of the result set.

$ ContextGenerator#LABELS_FLAGSProperty in class ContextGenerator

Labels and flags that may be used when defining keywords.

$ ContextGenerator#LINKSProperty 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.

M

OptionsArray::merge() — Method in class OptionsArray

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

$ Context#MODEProperty in class Context

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

MaintenanceStatementClass in namespace PhpMyAdmin\SqlParser\Statements

Maintenance statement.

CLI::mergeLongOpts() — Method in class CLI
MiscClass in namespace PhpMyAdmin\SqlParser\Utils

Miscellaneous utilities.

Tokens::match() — Method in class Tokens

Checks if a pattern is a match for the specified token.

N

$ CreateDefinition#nameProperty in class CreateDefinition

The name of the new column.

$ DataType#nameProperty in class DataType

The name of the data type.

$ FunctionCall#nameProperty in class FunctionCall

The name of this function.

$ Key#nameProperty in class Key

The name of this key.

$ ParameterDefinition#nameProperty in class ParameterDefinition

The name of the new column.

$ PartitionDefinition#nameProperty in class PartitionDefinition

The name of this partition.

$ RenameOperation#newProperty in class RenameOperation

The new table name.

$ WithKeyword#nameProperty in class WithKeyword
$ LoaderException#nameProperty in class LoaderException

The failed load name.

$ CreateStatement#nameProperty in class CreateStatement

The name of the entity that is created.

NotImplementedStatementClass in namespace PhpMyAdmin\SqlParser\Statements

Not implemented (yet) statements.

O

$ AlterOperation#optionsProperty in class AlterOperation

Options of this operation.

$ CreateDefinition#optionsProperty in class CreateDefinition

The options of this field.

$ DataType#optionsProperty in class DataType

The options of this data type.

$ JoinKeyword#onProperty in class JoinKeyword

Join conditions.

$ Key#optionsProperty in class Key

The options of this key.

$ Limit#offsetProperty in class Limit

The number of rows skipped.

OptionsArrayClass in namespace PhpMyAdmin\SqlParser\Components

Parses a list of options.

$ OptionsArray#optionsProperty in class OptionsArray

ArrayObj of selected options.

OrderKeywordClass in namespace PhpMyAdmin\SqlParser\Components

ORDER BY keyword parser.

$ PartitionDefinition#OPTIONSProperty in class PartitionDefinition

All field options.

$ PartitionDefinition#optionsProperty in class PartitionDefinition

The options of this field.

$ Reference#optionsProperty in class Reference

The options of the referencing.

$ RenameOperation#oldProperty in class RenameOperation

The old table name.

$ Context#OPERATORSProperty in class Context

List of operators and their flags.

$ Statement#OPTIONSProperty in class Statement

Options for this statement.

$ Statement#optionsProperty in class Statement

The options of this query.

$ AlterStatement#OPTIONSProperty in class AlterStatement

Options of this statement.

$ AnalyzeStatement#OPTIONSProperty in class AnalyzeStatement

Options of this statement.

$ BackupStatement#OPTIONSProperty in class BackupStatement

Options of this statement.

$ CheckStatement#OPTIONSProperty in class CheckStatement

Options of this statement.

$ ChecksumStatement#OPTIONSProperty in class ChecksumStatement

Options of this statement.

$ CreateStatement#OPTIONSProperty in class CreateStatement

Options for CREATE statements.

$ DeleteStatement#OPTIONSProperty in class DeleteStatement

Options for DELETE statements.

$ DeleteStatement#orderProperty in class DeleteStatement

Specifies the order of the rows in the result set.

$ DropStatement#OPTIONSProperty in class DropStatement

Options of this statement.

$ InsertStatement#OPTIONSProperty in class InsertStatement

Options for INSERT statements.

$ InsertStatement#onDuplicateSetProperty in class InsertStatement

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

$ LoadStatement#OPTIONSProperty in class LoadStatement

Options for LOAD statements and their slot ID.

OptimizeStatementClass in namespace PhpMyAdmin\SqlParser\Statements

OPTIMIZE statement.

$ OptimizeStatement#OPTIONSProperty in class OptimizeStatement

Options of this statement.

$ RepairStatement#OPTIONSProperty in class RepairStatement

Options of this statement.

$ ReplaceStatement#OPTIONSProperty in class ReplaceStatement

Options for REPLACE statements and their slot ID.

$ RestoreStatement#OPTIONSProperty in class RestoreStatement

Options of this statement.

$ SelectStatement#OPTIONSProperty in class SelectStatement

Options for SELECT statements and their slot ID.

$ SelectStatement#orderProperty in class SelectStatement

Specifies the order of the rows in the result set.

$ SetStatement#OPTIONSProperty in class SetStatement

Possible exceptions in SET statement.

$ SetStatement#optionsProperty in class SetStatement

Options used in current statement.

$ ShowStatement#OPTIONSProperty in class ShowStatement

Options of this statement.

$ TransactionStatement#OPTIONSProperty in class TransactionStatement

Options for this query.

$ TruncateStatement#OPTIONSProperty in class TruncateStatement

Options for TRUNCATE statements.

$ UpdateStatement#OPTIONSProperty in class UpdateStatement

Options for UPDATE statements and their slot ID.

$ UpdateStatement#orderProperty in class UpdateStatement

Specifies the order of the rows in the result set.

$ WithStatement#OPTIONSProperty in class WithStatement

Options for WITH statements and their slot ID.

TokensList::offsetSet() — Method in class TokensList

Sets an value inside the container.

TokensList::offsetGet() — Method in class TokensList

Gets a value from the container.

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.

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#optionsProperty in class BufferedQuery

The options of this parser.

$ Formatter#optionsProperty in class Formatter

The formatting options.

P

Component::parse() — Method in class Component

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

AlterOperation::parse() — Method in class AlterOperation
Array2d::parse() — Method in class Array2d
ArrayObj::parse() — Method in class ArrayObj
CaseExpression::parse() — Method in class CaseExpression
Condition::parse() — Method in class Condition
CreateDefinition::parse() — Method in class CreateDefinition
$ DataType#parametersProperty in class DataType

The parameters of this data type.

DataType::parse() — Method in class DataType
Expression::parse() — Method in class Expression

Possible options:.

ExpressionArray::parse() — Method in class ExpressionArray
$ FunctionCall#parametersProperty in class FunctionCall

The list of parameters.

FunctionCall::parse() — Method in class FunctionCall
GroupKeyword::parse() — Method in class GroupKeyword
IndexHint::parse() — Method in class IndexHint
IntoKeyword::parse() — Method in class IntoKeyword
IntoKeyword::parseFileOptions() — Method in class IntoKeyword
JoinKeyword::parse() — Method in class JoinKeyword
Key::parse() — Method in class Key
Limit::parse() — Method in class Limit
LockExpression::parse() — Method in class LockExpression
OptionsArray::parse() — Method in class OptionsArray
OrderKeyword::parse() — Method in class OrderKeyword
ParameterDefinitionClass in namespace PhpMyAdmin\SqlParser\Components

The definition of a parameter of a function or procedure.

ParameterDefinition::parse() — Method in class ParameterDefinition
PartitionDefinitionClass in namespace PhpMyAdmin\SqlParser\Components

Parses the create definition of a partition.

PartitionDefinition::parse() — Method in class PartitionDefinition
Reference::parse() — Method in class Reference
RenameOperation::parse() — Method in class RenameOperation
SetOperation::parse() — Method in class SetOperation
$ LexerException#posProperty in class LexerException

The index of the character that produced this error.

ParserExceptionClass in namespace PhpMyAdmin\SqlParser\Exceptions

Exception thrown by the parser.

$ Lexer#PARSER_METHODSProperty in class Lexer

A list of methods that are used in lexing the SQL query.

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.

ParserClass in namespace PhpMyAdmin\SqlParser

Takes multiple tokens (contained in a Lexer instance) as input and builds a parse tree.

Parser::parse() — Method in class Parser

Builds the parse trees.

Statement::parse() — Method in class Statement

Parses the statements defined by the tokens list.

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

Expression used for partitioning.

$ CreateStatement#partitionsNumProperty in class CreateStatement

The number of partitions.

$ CreateStatement#partitionsProperty in class CreateStatement

The partition of the new table.

$ CreateStatement#parametersProperty in class CreateStatement

The parameters of this routine.

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

Partitions used as source for this statement.

DeleteStatement::parse() — Method in class DeleteStatement
InsertStatement::parse() — Method in class InsertStatement
$ LoadStatement#partitionProperty 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
PurgeStatementClass in namespace PhpMyAdmin\SqlParser\Statements

PURGE statement.

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

Partitions used as source for this statement.

$ SelectStatement#procedureProperty in class SelectStatement

Procedure that should process the data in the result set.

TransactionStatement::parse() — Method in class TransactionStatement
WithStatement::parse() — Method in class WithStatement
$ Token#positionProperty 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#queryProperty in class BufferedQuery

The query that is being processed.

QueryClass in namespace PhpMyAdmin\SqlParser\Utils

Statement utilities.

R

$ ArrayObj#rawProperty in class ArrayObj

The array that contains the unprocessed value of each token.

$ CaseExpression#resultsProperty in class CaseExpression

The results matching with the WHEN clauses.

$ CreateDefinition#referencesProperty in class CreateDefinition

The table that is referenced.

$ Limit#rowCountProperty in class Limit

The number of rows to be returned.

OptionsArray::remove() — Method in class OptionsArray

Removes the option from the array.

ReferenceClass in namespace PhpMyAdmin\SqlParser\Components

REFERENCES keyword parser.

$ Reference#REFERENCES_OPTIONSProperty in class Reference

All references options.

RenameOperationClass in namespace PhpMyAdmin\SqlParser\Components

RENAME TABLE keyword parser.

$ CreateStatement#returnProperty in class CreateStatement

The return data type of this routine.

$ LoadStatement#replace_ignoreProperty in class LoadStatement

REPLACE/IGNORE Keyword.

RenameStatementClass in namespace PhpMyAdmin\SqlParser\Statements

RENAME statement.

$ RenameStatement#renamesProperty in class RenameStatement

The old and new names of the tables.

RepairStatementClass in namespace PhpMyAdmin\SqlParser\Statements

REPAIR statement.

ReplaceStatementClass in namespace PhpMyAdmin\SqlParser\Statements

REPLACE statement.

RestoreStatementClass 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::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.

RoutineClass in namespace PhpMyAdmin\SqlParser\Utils

Routine utilities.

Tokens::replaceTokens() — Method in class Tokens

S

$ Expression#subqueryProperty in class Expression

The type of subquery.

$ PartitionDefinition#subpartitionsProperty in class PartitionDefinition

The subpartitions of this partition.

SetOperationClass in namespace PhpMyAdmin\SqlParser\Components

SET keyword parser.

$ WithKeyword#statementProperty in class WithKeyword
Context::setMode() — Method in class Context

Sets the SQL mode.

$ Core#strictProperty in class Core

Whether errors should throw exceptions or just be stored.

$ Lexer#strProperty in class Lexer

The string to be parsed.

Lexer::setDelimiter() — Method in class Lexer

Sets the delimiter.

$ Parser#STATEMENT_PARSERSProperty in class Parser

Array of classes that are used in parsing the SQL statements.

$ Parser#statementsProperty in class Parser

List of statements parsed.

StatementClass in namespace PhpMyAdmin\SqlParser

Abstract statement definition.

$ CreateStatement#selectProperty in class CreateStatement

If CREATE TABLE ... SELECT.

$ CreateStatement#subpartitionByProperty in class CreateStatement

Expression used for subpartitioning.

$ CreateStatement#subpartitionsNumProperty in class CreateStatement

The number of subpartitions.

$ InsertStatement#setProperty in class InsertStatement

If SET clause is present holds the SetOperation.

$ InsertStatement#selectProperty in class InsertStatement

If SELECT clause is present holds the SelectStatement.

$ LoadStatement#setProperty in class LoadStatement

SET clause's updated values(optional).

$ ReplaceStatement#setProperty in class ReplaceStatement

If SET clause is present holds the SetOperation.

$ ReplaceStatement#selectProperty in class ReplaceStatement

If SELECT clause is present holds the SelectStatement.

SelectStatementClass in namespace PhpMyAdmin\SqlParser\Statements

SELECT statement.

SetStatementClass in namespace PhpMyAdmin\SqlParser\Statements

SET statement.

$ SetStatement#setProperty in class SetStatement

The updated values.

ShowStatementClass in namespace PhpMyAdmin\SqlParser\Statements

SHOW statement.

$ TransactionStatement#statementsProperty in class TransactionStatement

The list of statements in this transaction.

$ UpdateStatement#setProperty in class UpdateStatement

The updated values.

ContextGenerator::sortWords() — Method in class ContextGenerator

Sorts an array of words.

$ UtfString#strProperty in class UtfString

The raw, multi-byte string.

$ BufferedQuery#statusProperty in class BufferedQuery

The current status of the parser.

BufferedQuery::setDelimiter() — Method in class BufferedQuery

Sets the delimiter.

$ Formatter#SHORT_CLAUSESProperty in class Formatter

Clauses that are usually short.

T

$ AlterOperation#TABLE_OPTIONSProperty in class AlterOperation

All table options.

$ CreateDefinition#typeProperty in class CreateDefinition

The data type of thew new column.

$ Expression#tableProperty in class Expression

The name of this table.

$ GroupKeyword#typeProperty in class GroupKeyword
$ IndexHint#typeProperty in class IndexHint

The type of hint (USE/FORCE/IGNORE)

$ IntoKeyword#typeProperty in class IntoKeyword

Type of target (OUTFILE or SYMBOL).

$ JoinKeyword#typeProperty in class JoinKeyword

Type of this join.

$ Key#typeProperty in class Key

The type of this key.

$ LockExpression#tableProperty in class LockExpression

The table to be locked.

$ LockExpression#typeProperty in class LockExpression

The type of lock to be applied.

$ OrderKeyword#typeProperty in class OrderKeyword

The order type.

$ ParameterDefinition#typeProperty in class ParameterDefinition

The data type of thew new column.

$ PartitionDefinition#typeProperty in class PartitionDefinition

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

$ Reference#tableProperty in class Reference

The referenced table.

$ ParserException#tokenProperty in class ParserException

The token that produced this error.

$ AlterStatement#tableProperty in class AlterStatement

Table affected.

$ AnalyzeStatement#tablesProperty in class AnalyzeStatement

Analyzed tables.

$ CreateStatement#TABLE_OPTIONSProperty in class CreateStatement

All table options.

$ CreateStatement#TRIGGER_OPTIONSProperty in class CreateStatement

All trigger options.

$ CreateStatement#tableProperty in class CreateStatement

If CREATE TRIGGER the name of the table.

$ DropStatement#tableProperty in class DropStatement

Table of the dropped index.

$ LoadStatement#tableProperty in class LoadStatement

Table used as destination for this statement.

$ MaintenanceStatement#tablesProperty in class MaintenanceStatement

Tables maintained.

$ OptimizeStatement#tablesProperty in class OptimizeStatement

Optimized tables.

TransactionStatementClass in namespace PhpMyAdmin\SqlParser\Statements

Transaction statement.

$ TransactionStatement#typeProperty in class TransactionStatement

The type of this query.

TruncateStatementClass in namespace PhpMyAdmin\SqlParser\Statements

TRUNCATE statement.

$ TruncateStatement#tableProperty in class TruncateStatement

The name of the truncated table.

$ UpdateStatement#tablesProperty in class UpdateStatement

Tables used as sources for this statement.

TokenClass in namespace PhpMyAdmin\SqlParser

A structure representing a lexeme that explicitly indicates its categorization for the purpose of parsing.

$ Token#tokenProperty in class Token

The token it its raw string representation.

$ Token#typeProperty in class Token

The type of this token.

TokensListClass in namespace PhpMyAdmin\SqlParser

A structure representing a list of tokens.

$ TokensList#tokensProperty in class TokensList

The array of tokens.

TestGeneratorClass in namespace PhpMyAdmin\SqlParser\Tools

Used for test generation.

TranslatorClass in namespace PhpMyAdmin\SqlParser
Formatter::toString() — Method in class Formatter

Tries to print the query and returns the result.

TableClass in namespace PhpMyAdmin\SqlParser\Utils

Table utilities.

TokensClass in namespace PhpMyAdmin\SqlParser\Utils

Token utilities.

U

$ AlterOperation#unknownProperty in class AlterOperation

Unparsed tokens.

$ JoinKeyword#usingProperty in class JoinKeyword

Columns in Using clause.

UnionKeywordClass in namespace PhpMyAdmin\SqlParser\Components

UNION keyword builder.

$ DeleteStatement#usingProperty in class DeleteStatement

Tables used as sources for this statement.

$ NotImplementedStatement#unknownProperty in class NotImplementedStatement

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

$ SelectStatement#unionProperty in class SelectStatement

Unions.

UpdateStatementClass in namespace PhpMyAdmin\SqlParser\Statements

UPDATE statement.

UtfStringClass in namespace PhpMyAdmin\SqlParser

Implements array-like access for UTF-8 strings.

CLI::usageHighlight() — Method in class CLI
CLI::usageLint() — Method in class CLI
CLI::usageTokenize() — Method in class CLI

V

$ AlterOperation#VIEW_OPTIONSProperty in class AlterOperation

All view options.

$ ArrayObj#valuesProperty in class ArrayObj

The array that contains the processed value of each token.

$ CaseExpression#valueProperty in class CaseExpression

The value to be compared.

$ IntoKeyword#valuesProperty in class IntoKeyword

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

$ SetOperation#valueProperty 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#valuesProperty in class InsertStatement

Values to be inserted.

$ ReplaceStatement#valuesProperty in class ReplaceStatement

Values to be replaced.

$ Token#valueProperty in class Token

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

W

WithKeywordClass in namespace PhpMyAdmin\SqlParser\Components

WITH keyword builder.

$ DeleteStatement#whereProperty in class DeleteStatement

Conditions used for filtering each row of the result set.

$ SelectStatement#whereProperty in class SelectStatement

Conditions used for filtering each row of the result set.

$ UpdateStatement#whereProperty in class UpdateStatement

Conditions used for filtering each row of the result set.

WithStatementClass in namespace PhpMyAdmin\SqlParser\Statements

WITH statement.

$ WithStatement#withersProperty in class WithStatement

_

Component::__toString() — Method in class Component

Builds the string representation of a component of this type.

AlterOperation::__construct() — Method in class AlterOperation
ArrayObj::__construct() — Method in class ArrayObj
CaseExpression::__construct() — Method in class CaseExpression
Condition::__construct() — Method in class Condition
CreateDefinition::__construct() — Method in class CreateDefinition
DataType::__construct() — 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')

FunctionCall::__construct() — Method in class FunctionCall
GroupKeyword::__construct() — Method in class GroupKeyword
IndexHint::__construct() — Method in class IndexHint
IntoKeyword::__construct() — Method in class IntoKeyword
JoinKeyword::__construct() — Method in class JoinKeyword
Key::__construct() — Method in class Key
Limit::__construct() — Method in class Limit
OptionsArray::__construct() — Method in class OptionsArray
OrderKeyword::__construct() — Method in class OrderKeyword
ParameterDefinition::__construct() — Method in class ParameterDefinition
Reference::__construct() — Method in class Reference
RenameOperation::__construct() — Method in class RenameOperation
SetOperation::__construct() — Method in class SetOperation
WithKeyword::__construct() — Method in class WithKeyword
LexerException::__construct() — Method in class LexerException
LoaderException::__construct() — Method in class LoaderException
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
Formatter::__construct() — Method in class Formatter