Documentation

Lexer extends AbstractLexer

in package

• Application

Scans a DQL query for tokens.

Tags

extends

AbstractLexer<Lexer::T_*, string>

Table of Contents

Constants

T_ALIASED_NAME  = 100

T_ALL  = 200

T_AND  = 201

T_ANY  = 202

T_AS  = 203

T_ASC  = 204

T_AVG  = 205

T_BETWEEN  = 206

T_BOTH  = 207

T_BY  = 208

T_CASE  = 209

T_CLOSE_CURLY_BRACE  = 19

T_CLOSE_PARENTHESIS  = 6

T_COALESCE  = 210

T_COMMA  = 8

T_COUNT  = 211

T_DELETE  = 212

T_DESC  = 213

T_DISTINCT  = 214

T_DIVIDE  = 9

T_DOT  = 10

T_ELSE  = 215

T_EMPTY  = 216

T_END  = 217

T_EQUALS  = 11

T_ESCAPE  = 218

T_EXISTS  = 219

T_FALSE  = 220

T_FLOAT  = 5

T_FROM  = 221

T_FULLY_QUALIFIED_NAME  = 101

T_GREATER_THAN  = 12

T_GROUP  = 222

T_HAVING  = 223

T_HIDDEN  = 224

T_IDENTIFIER  = 102

T_IN  = 225

T_INDEX  = 226

T_INNER  = 227

T_INPUT_PARAMETER  = 4

T_INSTANCE  = 228

T_INTEGER  = 2

T_IS  = 229

T_JOIN  = 230

T_LEADING  = 231

T_LEFT  = 232

T_LIKE  = 233

T_LOWER_THAN  = 13

T_MAX  = 234

T_MEMBER  = 235

T_MIN  = 236

T_MINUS  = 14

T_MULTIPLY  = 15

T_NEGATE  = 16

T_NEW  = 237

T_NONE  = 1

T_NOT  = 238

T_NULL  = 239

T_NULLIF  = 240

T_OF  = 241

T_OPEN_CURLY_BRACE  = 18

T_OPEN_PARENTHESIS  = 7

T_OR  = 242

T_ORDER  = 243

T_OUTER  = 244

T_PARTIAL  = 245

T_PLUS  = 17

T_SELECT  = 246

T_SET  = 247

T_SOME  = 248

T_STRING  = 3

T_SUM  = 249

T_THEN  = 250

T_TRAILING  = 251

T_TRUE  = 252

T_UPDATE  = 253

T_WHEN  = 254

T_WHERE  = 255

T_WITH  = 256

Properties

$lookahead  : array<string|int, mixed>|null

The next token in the input.

$token  : array<string|int, mixed>|null

The last matched/seen token.

$input  : string

Lexer original input string.

$peek  : int

Current peek of current lexer position.

$position  : int

Current lexer position in input string.

$regex  : string|null

Composed regex for input parsing.

$tokens  : array<int, Token<T, V>>

Array of scanned tokens.

Methods

__construct()  : mixed

Creates a new query scanner object.

getInputUntilPosition()  : string

Retrieve the original lexer's input until a given position.

getLiteral()  : int|string

Gets the literal for a given token.

glimpse()  : array<string|int, mixed>|null

Peeks at the next token, returns it and immediately resets the peek.

isA()  : bool

Checks if given value is identical to the given token.

isNextToken()  : bool

Checks whether a given token matches the current lookahead.

isNextTokenAny()  : bool

Checks whether any of the given tokens matches the current lookahead.

moveNext()  : bool

Moves to the next token in the input string.

peek()  : array<string|int, mixed>|null

Moves the lookahead token forward.

reset()  : void

Resets the lexer.

resetPeek()  : void

Resets the peek pointer to 0.

resetPosition()  : void

Resets the lexer position on the input to the given position.

setInput()  : void

Sets the input data to be tokenized.

skipUntil()  : void

Tells the lexer to skip input tokens until it sees a token with the given value.

getCatchablePatterns()  : array<string|int, string>

Lexical catchable patterns.

getModifiers()  : string

Regex modifiers

getNonCatchablePatterns()  : array<string|int, string>

Lexical non-catchable patterns.

getType()  : T|null

Retrieve token type. Also processes the token value if necessary.

scan()  : void

Scans the input string for tokens.