1. class
  2. PhpMyAdmin
  3. \
  4. SqlParser
  5. \
  6. Lexer

Lexer

class Lexer (View source)

Defines the lexer of the library.

This is one of the most important components, along with the parser.

Depends on context to extract lexemes.

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

The output of the lexer is affected by the context of the SQL statement.

Constants

private KEYWORD_NAME_INDICATORS

A list of keywords that indicate that the function keyword is not used as a function
private OPERATOR_NAME_INDICATORS

A list of operators that indicate that the function keyword is not used as a function

Properties

Exception[] $errors

List of errors that occurred during lexing.
UtfString $str

The string to be parsed.
int $len

The length of $str.
int $last

The index of the last parsed character.
TokensList $list

Tokens extracted from given strings.
static string $defaultDelimiter

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

Statements delimiter.
int $delimiterLen

The length of the delimiter.

Methods

__construct(UtfString $str, bool $strict = false, string|null $delimiter = null)

No description

void
setDelimiter(string $delimiter)

Sets the delimiter.

void
lex()

Parses the string and extracts lexemes.

void
error(string $msg, string $str = '', int $pos = 0, int $code = 0)

Creates a new error log.

Token|null
parseKeyword()

Parses a keyword.

Token|null
parseLabel()

Parses a label.

Token|null
parseOperator()

Parses an operator.

Token|null
parseWhitespace()

Parses a whitespace.

Token|null
parseComment()

Parses a comment.

Token|null
parseBool()

Parses a boolean.

Token|null
parseNumber()

Parses a number.

Token|null
parseString(string $quote = '')

Parses a string.

Token|null
parseSymbol()

Parses a symbol.

Token|null
parseUnknown()

Parses unknown parts of the query.

Token|null
parseDelimiter()

Parses the delimiter of the query.

Details

at line 116
__construct(UtfString $str, bool $strict = false, string|null $delimiter = null)

No description

Parameters

UtfString $str

the query to be lexed
bool $strict

whether strict mode should be enabled or not
string|null $delimiter

the delimiter to be used

at line 147
void setDelimiter(string $delimiter)

Sets the delimiter.

Parameters

string $delimiter

the new delimiter

Return Value

void

at line 156
void lex()

Parses the string and extracts lexemes.

Return Value

void

at line 372
void error(string $msg, string $str = '', int $pos = 0, int $code = 0)

Creates a new error log.

Parameters

string $msg

the error message
string $str

the character that produced the error
int $pos

the position of the character
int $code

the code of the error

Return Value

void

Exceptions

LexerException

at line 391
Token|null parseKeyword()

Parses a keyword.

Return Value

Token|null

at line 447
Token|null parseLabel()

Parses a label.

Return Value

Token|null

at line 489
Token|null parseOperator()

Parses an operator.

Return Value

Token|null

at line 523
Token|null parseWhitespace()

Parses a whitespace.

Return Value

Token|null

at line 543
Token|null parseComment()

Parses a comment.

Return Value

Token|null

at line 660
Token|null parseBool()

Parses a boolean.

Return Value

Token|null

at line 691
Token|null parseNumber()

Parses a number.

Return Value

Token|null

at line 866
Token|null parseString(string $quote = '')

Parses a string.

Parameters

string $quote

additional starting symbol

Return Value

Token|null

Exceptions

LexerException

at line 916
Token|null parseSymbol()

Parses a symbol.

Return Value

Token|null

Exceptions

LexerException

at line 963
Token|null parseUnknown()

Parses unknown parts of the query.

Return Value

Token|null

at line 989
Token|null parseDelimiter()

Parses the delimiter of the query.

Return Value

Token|null