class TokenIterator

Traversing helper.

Traits

Better OOP experience.

Properties

array $tokens
int $position
array $ignored

Methods

__construct(array $tokens)

No description

array|null
currentToken()

Returns current token.

string|null
currentValue()

Returns current token value.

array|null
nextToken(int|string ...$args)

Returns next token.

string|null
nextValue(int|string ...$args)

Returns next token value.

array
nextAll(int|string ...$args)

Returns all next tokens.

array
nextUntil(int|string ...$args)

Returns all next tokens until it sees a given token type or value.

string
joinAll(int|string ...$args)

Returns concatenation of all next token values.

string
joinUntil(int|string ...$args)

Returns concatenation of all next tokens until it sees a given token type or value.

bool
isCurrent(int|string ...$args)

Checks the current token.

bool
isNext(int|string ...$args)

Checks the next token existence.

bool
isPrev(int|string ...$args)

Checks the previous token existence.

string
consumeValue(int|string ...$args)

Returns next expected token or throws exception.

reset()

No description

void
next()

Moves cursor to next token.

mixed
scan(array $wanted, bool $onlyFirst, bool $advance, bool $strings = false, bool $until = false, bool $prev = false)

Looks for (first) (not) wanted tokens.

Details

at line 34
__construct(array $tokens)

Parameters

array $tokens

at line 43
array|null currentToken()

Returns current token.

Return Value

array|null

at line 52
string|null currentValue()

Returns current token value.

Return Value

string|null

at line 62
array|null nextToken(int|string ...$args)

Returns next token.

Parameters

int|string ...$args desired token type or value

Return Value

array|null

at line 72
string|null nextValue(int|string ...$args)

Returns next token value.

Parameters

int|string ...$args desired token type or value

Return Value

string|null

at line 83
array nextAll(int|string ...$args)

Returns all next tokens.

Parameters

int|string ...$args desired token type or value

Return Value

array

at line 94
array nextUntil(int|string ...$args)

Returns all next tokens until it sees a given token type or value.

Parameters

int|string ...$args token type or value to stop before (required)

Return Value

array

at line 104
string joinAll(int|string ...$args)

Returns concatenation of all next token values.

Parameters

int|string ...$args token type or value to be joined

Return Value

string

at line 114
string joinUntil(int|string ...$args)

Returns concatenation of all next tokens until it sees a given token type or value.

Parameters

int|string ...$args token type or value to stop before (required)

Return Value

string

at line 124
bool isCurrent(int|string ...$args)

Checks the current token.

Parameters

int|string ...$args token type or value

Return Value

bool

at line 139
bool isNext(int|string ...$args)

Checks the next token existence.

Parameters

int|string ...$args token type or value

Return Value

bool

at line 149
bool isPrev(int|string ...$args)

Checks the previous token existence.

Parameters

int|string ...$args token type or value

Return Value

bool

at line 160
string consumeValue(int|string ...$args)

Returns next expected token or throws exception.

Parameters

int|string ...$args desired token type or value

Return Value

string

Exceptions

CompileException

at line 176
TokenIterator reset()

Return Value

TokenIterator

at line 186
protected void next()

Moves cursor to next token.

Return Value

void

at line 197
protected mixed scan(array $wanted, bool $onlyFirst, bool $advance, bool $strings = false, bool $until = false, bool $prev = false)

Looks for (first) (not) wanted tokens.

Parameters

array $wanted
bool $onlyFirst
bool $advance
bool $strings
bool $until
bool $prev

Return Value

mixed