SqlToken

API reference › yii › db › SqlToken

class	`yii\db\SqlToken`
Extends	`yii\base\BaseObject`
Implements	`ArrayAccess`, `yii\base\Configurable`
Since	2.0.13
Source	`framework/db/SqlToken.php`

SqlToken represents SQL tokens produced by SqlTokenizer or its child classes.

Properties

Property	Type	Description	Defined by
`$children`	`SqlToken[]`	Child tokens.	`SqlToken`
`$content`	`string\|null`	Token content. Default: `null`.	`SqlToken`
`$endOffset`	`int`	Original SQL token end position. Default: `null`.	`SqlToken`
`$hasChildren` read-only	`bool`	Whether the token has children.	`SqlToken`
`$isCollection` read-only	`bool`	Whether the token represents a collection of tokens.	`SqlToken`
`$parent`	`SqlToken`	Parent token. Default: `null`.	`SqlToken`
`$sql` read-only	`string`	SQL code.	`SqlToken`
`$startOffset`	`int`	Original SQL token start position. Default: `null`.	`SqlToken`
`$type`	`int`	Token type. Default: `self::TYPE_TOKEN`.	`SqlToken`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\BaseObject`
`__get()`	Returns the value of an object property.	`yii\base\BaseObject`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\BaseObject`
`__set()`	Sets value of an object property.	`yii\base\BaseObject`
`__toString()`	Returns the SQL code representing the token.	`SqlToken`
`__unset()`	Sets an object property to null.	`yii\base\BaseObject`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\BaseObject`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\BaseObject`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`getChildren()`	Returns child tokens.	`SqlToken`
`getHasChildren()`	Returns whether the token represents a collection of tokens and has non-zero number of children.	`SqlToken`
`getIsCollection()`	Returns whether the token represents a collection of tokens.	`SqlToken`
`getSql()`	Returns the SQL code representing the token.	`SqlToken`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\BaseObject`
`hasProperty()`	Returns a value indicating whether a property is defined.	`yii\base\BaseObject`
`init()`	Initializes the object.	`yii\base\BaseObject`
`matches()`	Returns whether this token (including its children) matches the specified “pattern” SQL code.	`SqlToken`
`offsetExists()`	Returns whether there is a child token at the specified offset.	`SqlToken`
`offsetGet()`	Returns a child token at the specified offset.	`SqlToken`
`offsetSet()`	Adds a child token to the token.	`SqlToken`
`offsetUnset()`	Removes a child token at the specified offset.	`SqlToken`
`setChildren()`	Sets a list of child tokens.	`SqlToken`

Constants

Constant	Value	Defined by
`TYPE_CODE`	`0`	`SqlToken`
`TYPE_STATEMENT`	`1`	`SqlToken`
`TYPE_TOKEN`	`2`	`SqlToken`
`TYPE_PARENTHESIS`	`3`	`SqlToken`
`TYPE_KEYWORD`	`4`	`SqlToken`
`TYPE_OPERATOR`	`5`	`SqlToken`
`TYPE_IDENTIFIER`	`6`	`SqlToken`
`TYPE_STRING_LITERAL`	`7`	`SqlToken`

Property details

$type

public int $type = self::TYPE_TOKEN

Token type.

It has to be one of the following constants:

Method details

__toString()

public function __toString(): string

Returns the SQL code representing the token.

Returns

string: SQL code.

getChildren()

public function getChildren(): yii\db\SqlToken[]

Returns child tokens.

Returns

SqlToken[]: Child tokens.

getHasChildren()

public function getHasChildren(): bool

Returns whether the token represents a collection of tokens and has non-zero number of children.

Returns

bool: Whether the token has children.

getIsCollection()

public function getIsCollection(): bool

Returns whether the token represents a collection of tokens.

Returns

bool: Whether the token represents a collection of tokens.

getSql()

public function getSql(): string

Returns the SQL code representing the token.

Returns

string: SQL code.

matches()

public function matches(yii\db\SqlToken $patternToken, int $offset = 0, int|null &$firstMatchIndex = null, int|null &$lastMatchIndex = null): bool

Returns whether this token (including its children) matches the specified “pattern” SQL code.

Usage Example:

$patternToken = (new \yii\db\sqlite\SqlTokenizer('SELECT any FROM any'))->tokenize();
if ($sqlToken->matches($patternToken, 0, $firstMatchIndex, $lastMatchIndex)) {
    // ...
}

Parameters

Parameter	Type	Description
`$patternToken`	`SqlToken`	Tokenized SQL code to match against. In addition to normal SQL, the `any` keyword is supported which will match any number of keywords, identifiers, whitespaces.
`$offset`	`int`	Token children offset to start lookup with.
`$firstMatchIndex`	`int\|null`	Token children offset where a successful match begins.
`$lastMatchIndex`	`int\|null`	Token children offset where a successful match ends.

Returns

bool: Whether this token matches the pattern SQL code.

offsetExists()

public function offsetExists(int $offset): bool

Returns whether there is a child token at the specified offset.

This method is required by the SPL ArrayAccess interface. It is implicitly called when you use something like isset($token[$offset]).

Parameters

Parameter	Type	Description
`$offset`	`int`	Child token offset.

Returns

bool: Whether the token exists.

offsetGet()

public function offsetGet(int $offset): yii\db\SqlToken|null

Returns a child token at the specified offset.

This method is required by the SPL ArrayAccess interface. It is implicitly called when you use something like $child = $token[$offset];.

Parameters

Parameter	Type	Description
`$offset`	`int`	Child token offset.

Returns

SqlToken|null: The child token at the specified offset, null if there’s no token.

offsetSet()

public function offsetSet(int|null $offset, yii\db\SqlToken $token): mixed

Adds a child token to the token.

This method is required by the SPL ArrayAccess interface. It is implicitly called when you use something like $token[$offset] = $child;.

Parameters

Parameter	Type	Description
`$offset`	`int\|null`	Child token offset.
`$token`	`SqlToken`	Token to be added.

Returns

mixed

offsetUnset()

public function offsetUnset(int $offset): mixed

Removes a child token at the specified offset.

This method is required by the SPL ArrayAccess interface. It is implicitly called when you use something like unset($token[$offset]).

Parameters

Parameter	Type	Description
`$offset`	`int`	Child token offset.

Returns

mixed

setChildren()

public function setChildren(yii\db\SqlToken[] $children): mixed

Sets a list of child tokens.

Parameters

Parameter	Type	Description
`$children`	`SqlToken[]`	Child tokens.

Returns

mixed