0 关注者

类 yii\db\sqlite\SqlTokenizer

继承关系yii\db\sqlite\SqlTokenizer » yii\db\SqlTokenizer » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
可用版本2.0.13
源代码 https://github.com/yiisoft/yii2/blob/master/framework/db/sqlite/SqlTokenizer.php

SqlTokenizer 将 SQLite 查询拆分为单独的 SQL 令牌。

它用于从 CREATE TABLE SQL 代码中获取 CHECK 约束信息。

另请参阅

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$length integer SQL 代码字符串长度。 yii\db\SqlTokenizer
$offset integer SQL 代码字符串当前偏移量。 yii\db\SqlTokenizer
$sql string SQL 代码。 yii\db\SqlTokenizer

受保护的属性

隐藏继承的属性

属性 类型 描述 定义于

公共方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法在通过克隆现有对象创建对象后被调用。 yii\base\Component
__construct() 构造函数。 yii\db\SqlTokenizer
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置,即定义且不为 null。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
behaviors() 返回此组件应表现为的行为列表。 yii\base\Component
canGetProperty() 返回一个值,指示属性是否可以读取。 yii\base\Component
canSetProperty() 返回一个值,指示属性是否可以设置。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
detachBehavior() 从组件分离行为。 yii\base\Component
detachBehaviors() 从组件分离所有行为。 yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到命名的事件。 yii\base\Component
hasMethod() 返回一个值,指示方法是否已定义。 yii\base\Component
hasProperty() 返回一个值,指示此组件是否定义了属性。 yii\base\Component
init() 初始化对象。 yii\base\BaseObject
off() 从此组件分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
tokenize() 标记化并返回代码类型令牌。 yii\db\SqlTokenizer
trigger() 触发事件。 yii\base\Component

受保护的方法

隐藏继承的方法

方法 描述 定义于
indexAfter() 返回 SQL 代码中给定字符串之后的索引,从指定的偏移量开始。 yii\db\SqlTokenizer
isComment() 返回当前偏移量处是否存在注释。 yii\db\sqlite\SqlTokenizer
isIdentifier() 返回当前偏移量处是否存在标识符。 yii\db\sqlite\SqlTokenizer
isKeyword() 返回给定字符串是否为关键字。 yii\db\sqlite\SqlTokenizer
isOperator() 返回当前偏移量处是否存在运算符。 yii\db\sqlite\SqlTokenizer
isStringLiteral() 返回当前偏移量处是否存在字符串文字。 yii\db\sqlite\SqlTokenizer
isWhitespace() 返回当前偏移量处是否存在空格。 yii\db\sqlite\SqlTokenizer
startsWithAnyLongest() 返回最长公共前缀是否等于 SQL 代码在当前偏移量处相同长度的前缀。 yii\db\SqlTokenizer
substring() 返回从指定偏移量开始的给定长度的字符串。 yii\db\SqlTokenizer

方法详情

隐藏继承的方法

__call() 公共方法

定义于: yii\base\Component::__call()

调用不是类方法的命名方法。

此方法将检查任何附加的行为是否具有命名方法,如果可用则执行它。

不要直接调用此方法,因为它是一个 PHP 魔术方法,当调用未知方法时会隐式调用它。

public mixed __call ( $name, $params )
$name string

方法名

$params array

方法参数

返回值 mixed

方法返回值

抛出 yii\base\UnknownMethodException

调用未知方法时

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() 公共方法

定义于: yii\base\Component::__clone()

此方法在通过克隆现有对象创建对象后被调用。

它删除所有行为,因为它们附加到旧对象。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() 公共方法

定义于: yii\db\SqlTokenizer::__construct()

构造函数。

public void __construct ( $sql, $config = [] )
$sql string

要标记化的 SQL 代码。

$config array

将用于初始化对象属性的名称-值对

                public function __construct($sql, $config = [])
{
    $this->sql = $sql;
    parent::__construct($config);
}

            
__get() 公共方法

定义于: yii\base\Component::__get()

返回组件属性的值。

此方法将按以下顺序检查并相应地采取行动

  • 由 getter 定义的属性:返回 getter 结果
  • 行为的属性:返回行为属性值

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $value = $component->property; 时会隐式调用。

另请参阅 __set()

public mixed __get ( $name )
$name string

属性名称

返回值 mixed

属性值或行为属性的值

抛出 yii\base\UnknownPropertyException

如果未定义属性

抛出 yii\base\InvalidCallException

如果属性为只写。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() 公共方法

定义于: yii\base\Component::__isset()

检查属性是否已设置,即定义且不为 null。

此方法将按以下顺序检查并相应地采取行动

  • 由 setter 定义的属性:返回属性是否已设置
  • 行为的属性:返回属性是否已设置
  • 对于不存在的属性,返回 false

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 isset($component->property) 时会隐式调用。

另请参阅 https://php.ac.cn/manual/en/function.isset.php

public boolean __isset ( $name )
$name string

属性名称或事件名称

返回值 boolean

命名的属性是否已设置

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() 公共方法

定义于: yii\base\Component::__set()

设置组件属性的值。

此方法将按以下顺序检查并相应地采取行动

  • 由 setter 定义的属性:设置属性值
  • “on xyz”格式的事件:将处理程序附加到“xyz”事件
  • “as xyz”格式的行为:附加名为“xyz”的行为
  • 行为的属性:设置行为属性值

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 $component->property = $value; 时会隐式调用。

另请参阅 __get()

public void __set ( $name, $value )
$name string

属性名称或事件名称

$value mixed

属性值

抛出 yii\base\UnknownPropertyException

如果未定义属性

抛出 yii\base\InvalidCallException

如果属性为只读。

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() 公共方法

定义于: yii\base\Component::__unset()

将组件属性设置为 null。

此方法将按以下顺序检查并相应地采取行动

  • 由 setter 定义的属性:将属性值设置为 null
  • 行为的属性:将属性值设置为 null

不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 unset($component->property) 时会隐式调用。

另请参阅 https://php.ac.cn/manual/en/function.unset.php

public void __unset ( $name )
$name string

属性名称

抛出 yii\base\InvalidCallException

如果属性为只读。

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
attachBehavior() 公共方法

定义于: yii\base\Component::attachBehavior()

将行为附加到此组件。

此方法将根据给定的配置创建行为对象。之后,行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。

另请参阅 detachBehavior()

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行为的名称。

$behavior string|array|yii\base\Behavior

行为配置。可以是以下之一

返回值 yii\base\Behavior

行为对象

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() 公共方法

定义于: yii\base\Component::attachBehaviors()

将行为列表附加到组件。

每个行为都由其名称索引,并且应该是一个 yii\base\Behavior 对象、一个指定行为类的字符串或一个用于创建行为的配置数组。

另请参阅 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到组件的行为列表

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
behaviors() 公共方法

定义于: yii\base\Component::behaviors()

返回此组件应表现为的行为列表。

子类可以重写此方法以指定它们想要表现为的行为。

此方法的返回值应该是一个行为对象或配置数组,由行为名称索引。行为配置可以是指定行为类的字符串,也可以是以下结构的数组

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

请注意,行为类必须扩展自 yii\base\Behavior。可以使用名称或匿名方式附加行为。当数组键使用名称时,使用此名称,以后可以使用 getBehavior() 检索行为,或使用 detachBehavior() 分离行为。匿名行为无法检索或分离。

在此方法中声明的行为将自动附加到组件(按需)。

public array behaviors ( )
返回值 array

行为配置。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公共方法

定义于: yii\base\Component::canGetProperty()

返回一个值,指示属性是否可以读取。

如果以下条件满足,则可以读取属性

  • 类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可读属性(当 $checkBehaviors 为 true 时)。

另请参阅 canSetProperty()

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否可读

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() 公共方法

定义于: yii\base\Component::canSetProperty()

返回一个值,指示属性是否可以设置。

如果以下条件满足,则可以写入属性

  • 类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的可写属性(当 $checkBehaviors 为 true 时)。

另请参阅 canGetProperty()

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否可写

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() 公共静态方法
自 2.0.14 版本起已弃用。在 PHP >= 5.5 中,请使用 ::class 代替。

定义于: yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
返回值 string

此类的完整限定名称。

                public static function className()
{
    return get_called_class();
}

            
detachBehavior() 公共方法

定义于: yii\base\Component::detachBehavior()

从组件分离行为。

将调用行为的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行为的名称。

返回值 yii\base\Behavior|null

已分离的行为。如果行为不存在,则为 null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() 公共方法

定义于: yii\base\Component::detachBehaviors()

从组件分离所有行为。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() 公共方法

定义于: yii\base\Component::ensureBehaviors()

确保在 behaviors() 中声明的行为已附加到此组件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
getBehavior() 公共方法

定义于: yii\base\Component::getBehavior()

返回命名的行为对象。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行为名称

返回值 yii\base\Behavior|null

行为对象,如果行为不存在则为 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() 公共方法

定义于: yii\base\Component::getBehaviors()

返回附加到此组件的所有行为。

public yii\base\Behavior[] getBehaviors ( )
返回值 yii\base\Behavior[]

附加到此组件的行为列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
hasEventHandlers() 公共方法

定义于: yii\base\Component::hasEventHandlers()

返回一个值,指示是否有任何处理程序附加到命名的事件。

public boolean hasEventHandlers ( $name )
$name string

事件名称

返回值 boolean

是否存在任何附加到事件的处理程序。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() 公共方法

定义于: yii\base\Component::hasMethod()

返回一个值,指示方法是否已定义。

如果方法已定义,则表示

  • 类具有指定名称的方法
  • 附加的行为具有给定名称的方法(当 $checkBehaviors 为 true 时)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

属性名称

$checkBehaviors boolean

是否将行为的方法视为此组件的方法

返回值 boolean

方法是否已定义

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() 公共方法

定义于: yii\base\Component::hasProperty()

返回一个值,指示此组件是否定义了属性。

如果属性已定义,则表示

  • 类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
  • 类具有与指定名称相同的成员变量(当 $checkVars 为 true 时);
  • 附加的行为具有给定名称的属性(当 $checkBehaviors 为 true 时)。

另请参阅

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

属性名称

$checkVars boolean

是否将成员变量视为属性

$checkBehaviors boolean

是否将行为的属性视为此组件的属性

返回值 boolean

属性是否已定义

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
indexAfter() 受保护方法

定义于: yii\db\SqlTokenizer::indexAfter()

返回 SQL 代码中给定字符串之后的索引,从指定的偏移量开始。

protected integer indexAfter ( $string, $offset null )
$string string

要查找的字符串。

$offset integer|null

SQL 代码偏移量,如果传递 null,则默认为当前偏移量。

返回值 integer

给定字符串之后的索引或字符串末尾的索引。

                protected function indexAfter($string, $offset = null)
{
    if ($offset === null) {
        $offset = $this->offset;
    }
    if ($offset + mb_strlen($string, 'UTF-8') > $this->length) {
        return $this->length;
    }
    $afterIndexOf = mb_strpos($this->sql, $string, $offset, 'UTF-8');
    if ($afterIndexOf === false) {
        $afterIndexOf = $this->length;
    } else {
        $afterIndexOf += mb_strlen($string, 'UTF-8');
    }
    return $afterIndexOf;
}

            
init() 公共方法

定义于: yii\base\BaseObject::init()

初始化对象。

此方法在构造函数结束时调用,在对象使用给定配置初始化之后调用。

public void init ( )

                public function init()
{
}

            
isComment() 受保护方法

返回当前偏移量处是否存在注释。

如果此方法返回 true,则必须将 $length 参数设置为匹配字符串的长度。

protected boolean isComment ( &$length )
$length integer

匹配字符串的长度。

返回值 boolean

当前偏移量处是否存在注释。

                protected function isComment(&$length)
{
    static $comments = [
        '--' => true,
        '/*' => true,
    ];
    $length = 2;
    if (!isset($comments[$this->substring($length)])) {
        return false;
    }
    if ($this->substring($length) === '--') {
        $length = $this->indexAfter("\n") - $this->offset;
    } else {
        $length = $this->indexAfter('*/') - $this->offset;
    }
    return true;
}

            
isIdentifier() 受保护方法

返回当前偏移量处是否存在标识符。

如果此方法返回 true,则必须将 $length 参数设置为匹配字符串的长度。它还可以将 $content 设置为用作令牌内容的字符串。

受保护 布尔型 isIdentifier ( &$length, &$content )
$length integer

匹配字符串的长度。

$content string

匹配字符串之外的可选内容。

返回值 boolean

当前偏移量处是否存在标识符。

                protected function isIdentifier(&$length, &$content)
{
    static $identifierDelimiters = [
        '"' => '"',
        '[' => ']',
        '`' => '`',
    ];
    if (!isset($identifierDelimiters[$this->substring(1)])) {
        return false;
    }
    $delimiter = $identifierDelimiters[$this->substring(1)];
    $offset = $this->offset;
    while (true) {
        $offset = $this->indexAfter($delimiter, $offset + 1);
        if ($delimiter === ']' || $this->substring(1, true, $offset) !== $delimiter) {
            break;
        }
    }
    $length = $offset - $this->offset;
    $content = $this->substring($length - 2, true, $this->offset + 1);
    if ($delimiter !== ']') {
        $content = strtr($content, ["$delimiter$delimiter" => $delimiter]);
    }
    return true;
}

            
isKeyword() 受保护方法

返回给定字符串是否为关键字。

此方法可以将 $content 设置为用作令牌内容的字符串。

受保护 布尔型 isKeyword ( $string, &$content )
$string string

要匹配的字符串。

$content string

匹配字符串之外的可选内容。

返回值 boolean

给定字符串是否为关键字。

                protected function isKeyword($string, &$content)
{
    static $keywords = [
        'ABORT' => true,
        'ACTION' => true,
        'ADD' => true,
        'AFTER' => true,
        'ALL' => true,
        'ALTER' => true,
        'ANALYZE' => true,
        'AND' => true,
        'AS' => true,
        'ASC' => true,
        'ATTACH' => true,
        'AUTOINCREMENT' => true,
        'BEFORE' => true,
        'BEGIN' => true,
        'BETWEEN' => true,
        'BY' => true,
        'CASCADE' => true,
        'CASE' => true,
        'CAST' => true,
        'CHECK' => true,
        'COLLATE' => true,
        'COLUMN' => true,
        'COMMIT' => true,
        'CONFLICT' => true,
        'CONSTRAINT' => true,
        'CREATE' => true,
        'CROSS' => true,
        'CURRENT_DATE' => true,
        'CURRENT_TIME' => true,
        'CURRENT_TIMESTAMP' => true,
        'DATABASE' => true,
        'DEFAULT' => true,
        'DEFERRABLE' => true,
        'DEFERRED' => true,
        'DELETE' => true,
        'DESC' => true,
        'DETACH' => true,
        'DISTINCT' => true,
        'DROP' => true,
        'EACH' => true,
        'ELSE' => true,
        'END' => true,
        'ESCAPE' => true,
        'EXCEPT' => true,
        'EXCLUSIVE' => true,
        'EXISTS' => true,
        'EXPLAIN' => true,
        'FAIL' => true,
        'FOR' => true,
        'FOREIGN' => true,
        'FROM' => true,
        'FULL' => true,
        'GLOB' => true,
        'GROUP' => true,
        'HAVING' => true,
        'IF' => true,
        'IGNORE' => true,
        'IMMEDIATE' => true,
        'IN' => true,
        'INDEX' => true,
        'INDEXED' => true,
        'INITIALLY' => true,
        'INNER' => true,
        'INSERT' => true,
        'INSTEAD' => true,
        'INTERSECT' => true,
        'INTO' => true,
        'IS' => true,
        'ISNULL' => true,
        'JOIN' => true,
        'KEY' => true,
        'LEFT' => true,
        'LIKE' => true,
        'LIMIT' => true,
        'MATCH' => true,
        'NATURAL' => true,
        'NO' => true,
        'NOT' => true,
        'NOTNULL' => true,
        'NULL' => true,
        'OF' => true,
        'OFFSET' => true,
        'ON' => true,
        'OR' => true,
        'ORDER' => true,
        'OUTER' => true,
        'PLAN' => true,
        'PRAGMA' => true,
        'PRIMARY' => true,
        'QUERY' => true,
        'RAISE' => true,
        'RECURSIVE' => true,
        'REFERENCES' => true,
        'REGEXP' => true,
        'REINDEX' => true,
        'RELEASE' => true,
        'RENAME' => true,
        'REPLACE' => true,
        'RESTRICT' => true,
        'RIGHT' => true,
        'ROLLBACK' => true,
        'ROW' => true,
        'SAVEPOINT' => true,
        'SELECT' => true,
        'SET' => true,
        'TABLE' => true,
        'TEMP' => true,
        'TEMPORARY' => true,
        'THEN' => true,
        'TO' => true,
        'TRANSACTION' => true,
        'TRIGGER' => true,
        'UNION' => true,
        'UNIQUE' => true,
        'UPDATE' => true,
        'USING' => true,
        'VACUUM' => true,
        'VALUES' => true,
        'VIEW' => true,
        'VIRTUAL' => true,
        'WHEN' => true,
        'WHERE' => true,
        'WITH' => true,
        'WITHOUT' => true,
    ];
    $string = mb_strtoupper($string, 'UTF-8');
    if (!isset($keywords[$string])) {
        return false;
    }
    $content = $string;
    return true;
}

            
isOperator() 受保护方法

返回当前偏移量处是否存在运算符。

如果此方法返回 true,则必须将 $length 参数设置为匹配字符串的长度。它还可以将 $content 设置为用作令牌内容的字符串。

受保护 布尔型 isOperator ( &$length, &$content )
$length integer

匹配字符串的长度。

$content string

匹配字符串之外的可选内容。

返回值 boolean

当前偏移量处是否存在运算符。

                protected function isOperator(&$length, &$content)
{
    static $operators = [
        '!=',
        '%',
        '&',
        '(',
        ')',
        '*',
        '+',
        ',',
        '-',
        '.',
        '/',
        ';',
        '<',
        '<<',
        '<=',
        '<>',
        '=',
        '==',
        '>',
        '>=',
        '>>',
        '|',
        '||',
        '~',
    ];
    return $this->startsWithAnyLongest($operators, true, $length);
}

            
isStringLiteral() 受保护方法

返回当前偏移量处是否存在字符串文字。

如果此方法返回 true,则必须将 $length 参数设置为匹配字符串的长度。它还可以将 $content 设置为用作令牌内容的字符串。

受保护 布尔型 isStringLiteral ( &$length, &$content )
$length integer

匹配字符串的长度。

$content string

匹配字符串之外的可选内容。

返回值 boolean

当前偏移量处是否存在字符串字面量。

                protected function isStringLiteral(&$length, &$content)
{
    if ($this->substring(1) !== "'") {
        return false;
    }
    $offset = $this->offset;
    while (true) {
        $offset = $this->indexAfter("'", $offset + 1);
        if ($this->substring(1, true, $offset) !== "'") {
            break;
        }
    }
    $length = $offset - $this->offset;
    $content = strtr($this->substring($length - 2, true, $this->offset + 1), ["''" => "'"]);
    return true;
}

            
isWhitespace() 受保护方法

返回当前偏移量处是否存在空格。

如果此方法返回 true,则必须将 $length 参数设置为匹配字符串的长度。

受保护 布尔型 isWhitespace ( &$length )
$length integer

匹配字符串的长度。

返回值 boolean

当前偏移量处是否存在空格。

                protected function isWhitespace(&$length)
{
    static $whitespaces = [
        "\f" => true,
        "\n" => true,
        "\r" => true,
        "\t" => true,
        ' ' => true,
    ];
    $length = 1;
    return isset($whitespaces[$this->substring($length)]);
}

            
off() 公共方法

定义于: yii\base\Component::off()

从此组件分离现有的事件处理程序。

此方法与 on() 相反。

注意:如果为事件名称传递通配符模式,则只会删除使用此通配符注册的处理程序,而使用与该通配符匹配的普通名称注册的处理程序将保留。

另请参阅 on()

公共 布尔型 off ( $name, $handler null )
$name string

事件名称

$handler 可调用|

要移除的事件处理程序。如果为 null,则将移除附加到命名事件的所有处理程序。

返回值 boolean

如果找到并分离了处理程序

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() 公共方法

定义于: yii\base\Component::on()

将事件处理程序附加到事件。

事件处理程序必须是有效的 PHP 回调。以下是一些示例

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

事件处理程序必须使用以下签名定义,

function ($event)

其中 $event 是一个 yii\base\Event 对象,其中包含与事件关联的参数。

从 2.0.14 开始,您可以将事件名称指定为通配符模式

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

另请参阅 off()

公共 on ( $name, $handler, $data null, $append true )
$name string

事件名称

$handler 可调用

事件处理程序

$data mixed

触发事件时要传递给事件处理程序的数据。调用事件处理程序时,可以通过 yii\base\Event::$data 访问此数据。

$append boolean

是否将新的事件处理程序追加到现有处理程序列表的末尾。如果为 false,则新的处理程序将插入到现有处理程序列表的开头。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
startsWithAnyLongest() 受保护方法

定义于: yii\db\SqlTokenizer::startsWithAnyLongest()

返回最长公共前缀是否等于 SQL 代码在当前偏移量处相同长度的前缀。

受保护 布尔型 startsWithAnyLongest ( 数组 &$with, $caseSensitive, &$length null, &$content null )
$with string[]

要测试的字符串。此方法**将**修改此参数以加快查找速度。

$caseSensitive boolean

是否执行区分大小写的比较。

$length integer|null

匹配字符串的长度。

$content 字符串|

匹配的字符串。

返回值 boolean

是否找到匹配项。

                protected function startsWithAnyLongest(array &$with, $caseSensitive, &$length = null, &$content = null)
{
    if (empty($with)) {
        return false;
    }
    if (!is_array(reset($with))) {
        usort($with, function ($string1, $string2) {
            return mb_strlen($string2, 'UTF-8') - mb_strlen($string1, 'UTF-8');
        });
        $map = [];
        foreach ($with as $string) {
            $map[mb_strlen($string, 'UTF-8')][$caseSensitive ? $string : mb_strtoupper($string, 'UTF-8')] = true;
        }
        $with = $map;
    }
    foreach ($with as $testLength => $testValues) {
        $content = $this->substring($testLength, $caseSensitive);
        if (isset($testValues[$content])) {
            $length = $testLength;
            return true;
        }
    }
    return false;
}

            
substring() 受保护方法

定义于: yii\db\SqlTokenizer::substring()

返回从指定偏移量开始的给定长度的字符串。

受保护 字符串 substring ( $length, $caseSensitive true, $offset null )
$length integer

要返回的字符串长度。

$caseSensitive boolean

如果为 false,则字符串将转换为大写。

$offset integer|null

SQL 代码偏移量,如果传递 null,则默认为当前偏移量。

返回值 string

结果字符串,如果没有任何内容要返回,则它可能为空。

                protected function substring($length, $caseSensitive = true, $offset = null)
{
    if ($offset === null) {
        $offset = $this->offset;
    }
    if ($offset + $length > $this->length) {
        return '';
    }
    $cacheKey = $offset . ',' . $length;
    if (!isset($this->_substrings[$cacheKey . ',1'])) {
        $this->_substrings[$cacheKey . ',1'] = mb_substr($this->sql, $offset, $length, 'UTF-8');
    }
    if (!$caseSensitive && !isset($this->_substrings[$cacheKey . ',0'])) {
        $this->_substrings[$cacheKey . ',0'] = mb_strtoupper($this->_substrings[$cacheKey . ',1'], 'UTF-8');
    }
    return $this->_substrings[$cacheKey . ',' . (int) $caseSensitive];
}

            
tokenize() 公共方法

定义于: yii\db\SqlTokenizer::tokenize()

标记化并返回代码类型令牌。

公共 yii\db\SqlToken tokenize ( )
返回值 yii\db\SqlToken

代码类型令牌。

                public function tokenize()
{
    $this->length = mb_strlen($this->sql, 'UTF-8');
    $this->offset = 0;
    $this->_substrings = [];
    $this->_buffer = '';
    $this->_token = new SqlToken([
        'type' => SqlToken::TYPE_CODE,
        'content' => $this->sql,
    ]);
    $this->_tokenStack = new \SplStack();
    $this->_tokenStack->push($this->_token);
    $this->_token[] = new SqlToken(['type' => SqlToken::TYPE_STATEMENT]);
    $this->_tokenStack->push($this->_token[0]);
    $this->_currentToken = $this->_tokenStack->top();
    while (!$this->isEof()) {
        if ($this->isWhitespace($length) || $this->isComment($length)) {
            $this->addTokenFromBuffer();
            $this->advance($length);
            continue;
        }
        if ($this->tokenizeOperator($length) || $this->tokenizeDelimitedString($length)) {
            $this->advance($length);
            continue;
        }
        $this->_buffer .= $this->substring(1);
        $this->advance(1);
    }
    $this->addTokenFromBuffer();
    if ($this->_token->getHasChildren() && !$this->_token[-1]->getHasChildren()) {
        unset($this->_token[-1]);
    }
    return $this->_token;
}

            
trigger() 公共方法

定义于: yii\base\Component::trigger()

触发事件。

此方法表示事件的发生。它调用事件的所有附加处理程序,包括类级处理程序。

公共 trigger ( $name, yii\base\Event $event null )
$name string

事件名称

$event yii\base\Event|null

事件实例。如果未设置,将创建一个默认的 yii\base\Event 对象。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}