# Class yii\db\sqlite\SqlTokenizer

Inheritance | yii\db\sqlite\SqlTokenizer » yii\db\SqlTokenizer » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable
Available since version | 2.0.13
Source Code | https://github.com/yiisoft/yii2/blob/master/framework/db/sqlite/SqlTokenizer.php

SqlTokenizer splits SQLite query into individual SQL tokens.

It's used to obtain a `CHECK` constraint information from a `CREATE TABLE` SQL code.

See also:

- http://www.sqlite.org/draft/tokenreq.html
- https://sqlite.org/lang.html

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component
$sql | string | SQL code. | yii\db\SqlTokenizer

## Protected Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$length | integer | SQL code string length. | yii\db\SqlTokenizer
$offset | integer | SQL code string current offset. | yii\db\SqlTokenizer

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | yii\base\Component
__clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component
__construct() | Constructor. | yii\db\SqlTokenizer
__get() | Returns the value of a component property. | yii\base\Component
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component
__set() | Sets the value of a component property. | yii\base\Component
__unset() | Sets a component property to be null. | yii\base\Component
attachBehavior() | Attaches a behavior to this component. | yii\base\Component
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component
className() | Returns the fully qualified name of this class. | yii\base\BaseObject
detachBehavior() | Detaches a behavior from the component. | yii\base\Component
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component
getBehavior() | Returns the named behavior object. | yii\base\Component
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component
hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component
init() | Initializes the object. | yii\base\BaseObject
off() | Detaches an existing event handler from this component. | yii\base\Component
on() | Attaches an event handler to an event. | yii\base\Component
tokenize() | Tokenizes and returns a code type token. | yii\db\SqlTokenizer
trigger() | Triggers an event. | yii\base\Component

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
indexAfter() | Returns an index after the given string in the SQL code starting with the specified offset. | yii\db\SqlTokenizer
isComment() | Returns whether there's a commentary at the current offset. | yii\db\sqlite\SqlTokenizer
isIdentifier() | Returns whether there's an identifier at the current offset. | yii\db\sqlite\SqlTokenizer
isKeyword() | Returns whether the given string is a keyword. | yii\db\sqlite\SqlTokenizer
isOperator() | Returns whether there's an operator at the current offset. | yii\db\sqlite\SqlTokenizer
isStringLiteral() | Returns whether there's a string literal at the current offset. | yii\db\sqlite\SqlTokenizer
isWhitespace() | Returns whether there's a whitespace at the current offset. | yii\db\sqlite\SqlTokenizer
startsWithAnyLongest() | Returns whether the longest common prefix equals to the SQL code of the same length at the current offset. | yii\db\SqlTokenizer
substring() | Returns a string of the given length starting with the specified offset. | yii\db\SqlTokenizer

## Method Details

isComment() protected method

Returns whether there's a commentary at the current offset.

If this methos returns `true`, it has to set the `$length` parameter to the length of the matched string.

protected boolean isComment ( &$length )
$length | integer | Length of the matched string.
return | boolean | Whether there's a commentary at the current offset.

isIdentifier() protected method

Returns whether there's an identifier at the current offset.

If this methos returns `true`, it has to set the `$length` parameter to the length of the matched string. It may also set `$content` to a string that will be used as a token content.

protected boolean isIdentifier ( &$length, &$content )
$length | integer | Length of the matched string.
$content | string | Optional content instead of the matched string.
return | boolean | Whether there's an identifier at the current offset.

isKeyword() protected method

Returns whether the given string is a keyword.

The method may set `$content` to a string that will be used as a token content.

protected boolean isKeyword ( $string, &$content )
$string | string | String to be matched.
$content | string | Optional content instead of the matched string.
return | boolean | Whether the given string is a keyword.

isOperator() protected method

Returns whether there's an operator at the current offset.

If this methos returns `true`, it has to set the `$length` parameter to the length of the matched string. It may also set `$content` to a string that will be used as a token content.

protected boolean isOperator ( &$length, &$content )
$length | integer | Length of the matched string.
$content | string | Optional content instead of the matched string.
return | boolean | Whether there's an operator at the current offset.

isStringLiteral() protected method

Returns whether there's a string literal at the current offset.

If this methos returns `true`, it has to set the `$length` parameter to the length of the matched string. It may also set `$content` to a string that will be used as a token content.

protected boolean isStringLiteral ( &$length, &$content )
$length | integer | Length of the matched string.
$content | string | Optional content instead of the matched string.
return | boolean | Whether there's a string literal at the current offset.

isWhitespace() protected method

Returns whether there's a whitespace at the current offset.

If this methos returns `true`, it has to set the `$length` parameter to the length of the matched string.

protected boolean isWhitespace ( &$length )
$length | integer | Length of the matched string.
return | boolean | Whether there's a whitespace at the current offset.