0 关注者

类 yii\db\oci\Command

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

Command 表示要针对数据库执行的 Oracle SQL 语句。

{@inheritdoc}

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$db yii\db\Connection 此命令关联的数据库连接。 yii\db\Command
$fetchMode integer 此命令的默认获取模式。 yii\db\Command
$params array 绑定到当前 PDO 语句的参数(名称 => 值)。 yii\db\Command
$pdoStatement PDOStatement 此命令关联的 PDOStatement 对象。 yii\db\Command
$pendingParams array 待绑定到当前 PDO 语句的参数。 yii\db\Command
$queryCacheDependency yii\caching\Dependency 要与此命令的缓存查询结果关联的依赖项。 yii\db\Command
$queryCacheDuration integer 查询结果在缓存中保持有效的默认秒数。 yii\db\Command
$rawSql string 带有参数值的原始 SQL,这些参数值已插入到 $sql 中的相应占位符中。 yii\db\Command
$sql string 要执行的 SQL 语句。 yii\db\Command

受保护属性

隐藏继承的属性

属性 类型 描述 定义于

公共方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 在通过克隆现有对象创建对象后调用此方法。 yii\base\Component
__construct() 构造函数。 yii\base\BaseObject
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置,即已定义且不为空。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
addCheck() 创建用于向现有表添加检查约束的 SQL 命令。 yii\db\Command
addColumn() 创建用于添加新数据库列的 SQL 命令。 yii\db\Command
addCommentOnColumn() 构建用于向列添加注释的 SQL 命令。 yii\db\Command
addCommentOnTable() 构建用于向表添加注释的 SQL 命令。 yii\db\Command
addDefaultValue() 创建用于向现有表添加默认值约束的 SQL 命令。 yii\db\Command
addForeignKey() 创建用于向现有表添加外键约束的 SQL 命令。 yii\db\Command
addPrimaryKey() 创建用于向现有表添加主键约束的 SQL 命令。 yii\db\Command
addUnique() 创建用于向现有表添加唯一约束的 SQL 命令。 yii\db\Command
alterColumn() 创建用于更改列定义的 SQL 命令。 yii\db\Command
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
batchInsert() 创建批处理 INSERT 命令。 yii\db\Command
behaviors() 返回此组件应表现为的行为列表。 yii\base\Component
bindParam() 将参数绑定到要执行的 SQL 语句。 yii\db\Command
bindValue() 将值绑定到参数。 yii\db\Command
bindValues() 将值列表绑定到相应的参数。 yii\db\Command
cache() 启用此命令的查询缓存。 yii\db\Command
canGetProperty() 返回一个值,指示是否可以读取属性。 yii\base\Component
canSetProperty() 返回一个值,指示是否可以设置属性。 yii\base\Component
cancel() 取消 SQL 语句的执行。 yii\db\Command
checkIntegrity() 构建用于启用或禁用完整性检查的 SQL 命令。 yii\db\Command
className() 返回此类的完全限定名称。 yii\base\BaseObject
createIndex() 创建用于创建新索引的 SQL 命令。 yii\db\Command
createTable() 创建用于创建新数据库表的 SQL 命令。 yii\db\Command
createView() 创建 SQL 视图。 yii\db\Command
delete() 创建 DELETE 命令。 yii\db\Command
detachBehavior() 从组件中分离行为。 yii\base\Component
detachBehaviors() 从组件中分离所有行为。 yii\base\Component
dropCheck() 创建用于删除检查约束的 SQL 命令。 yii\db\Command
dropColumn() 创建用于删除数据库列的 SQL 命令。 yii\db\Command
dropCommentFromColumn() 构建用于从列中删除注释的 SQL 命令。 yii\db\Command
dropCommentFromTable() 构建用于从表中删除注释的 SQL 命令。 yii\db\Command
dropDefaultValue() 创建用于删除默认值约束的 SQL 命令。 yii\db\Command
dropForeignKey() 创建用于删除外键约束的 SQL 命令。 yii\db\Command
dropIndex() 创建用于删除索引的 SQL 命令。 yii\db\Command
dropPrimaryKey() 创建用于删除现有表的主键约束的 SQL 命令。 yii\db\Command
dropTable() 创建用于删除数据库表的 SQL 命令。 yii\db\Command
dropUnique() 创建用于删除唯一约束的 SQL 命令。 yii\db\Command
dropView() 删除 SQL 视图。 yii\db\Command
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
execute() 执行 SQL 语句。 yii\db\Command
executeResetSequence() 执行重置表的 primary key 序列值的数据库命令。 yii\db\Command
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getRawSql() 通过将参数值插入到 $sql 中的相应占位符中,返回原始 SQL。 yii\db\Command
getSql() 返回此命令的 SQL 语句。 yii\db\Command
hasEventHandlers() 返回一个值,指示是否有任何处理程序附加到命名的事件。 yii\base\Component
hasMethod() 返回一个值,指示方法是否已定义。 yii\base\Component
hasProperty() 返回一个值,指示是否为此组件定义了属性。 yii\base\Component
init() 初始化对象。 yii\base\BaseObject
insert() 创建 INSERT 命令。 yii\db\Command
noCache() 禁用此命令的查询缓存。 yii\db\Command
off() 从此组件中分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
prepare() 准备要执行的 SQL 语句。 yii\db\Command
query() 执行 SQL 语句并返回查询结果。 yii\db\Command
queryAll() 执行 SQL 语句并立即返回所有行。 yii\db\Command
queryColumn() 执行 SQL 语句并返回结果的第一列。 yii\db\Command
queryOne() 执行 SQL 语句并返回结果的第一行。 yii\db\Command
queryScalar() 执行 SQL 语句并返回数据第一行中第一列的值。 yii\db\Command
renameColumn() 创建用于重命名列的 SQL 命令。 yii\db\Command
renameTable() 创建用于重命名数据库表的 SQL 命令。 yii\db\Command
resetSequence() 创建用于重置表的 primary key 序列值的 SQL 命令。 yii\db\Command
setRawSql() 指定要执行的 SQL 语句。SQL 语句不会以任何方式修改。 yii\db\Command
setSql() 指定要执行的 SQL 语句。SQL 语句将使用 yii\db\Connection::quoteSql() 进行引用。 yii\db\Command
trigger() 触发一个事件。 yii\base\Component
truncateTable() 创建一个用于截断数据库表的 SQL 命令。 yii\db\Command
update() 创建一个 UPDATE 命令。 yii\db\Command
upsert() 创建一个命令,如果数据库表中不存在行(匹配唯一约束),则插入行,否则更新行。 yii\db\Command

受保护的方法

隐藏继承的方法

方法 描述 定义于
bindPendingParams() 绑定通过 bindValue()bindValues() 注册的挂起参数。 yii\db\oci\Command
getCacheKey() 返回查询的缓存键。 yii\db\Command
internalExecute() 执行预处理语句。 yii\db\Command
logQuery() 如果启用了查询日志记录,则记录当前数据库查询,如果启用了性能分析,则返回性能分析令牌。 yii\db\Command
queryInternal() 执行 SQL 语句的实际数据库查询。 yii\db\Command
refreshTableSchema() 刷新由 requireTableSchemaRefresh() 标记的表架构。 yii\db\Command
requireTableSchemaRefresh() 标记在命令执行后要刷新的指定表架构。 yii\db\Command
requireTransaction() 标记命令在事务中执行。 yii\db\Command
reset() 将命令属性重置为其初始状态。 yii\db\Command
setRetryHandler() 设置一个可调用对象(例如匿名函数),当执行命令时抛出 yii\db\Exception 时调用该对象。可调用对象的签名应为 yii\db\Command

方法详情

隐藏继承的方法

__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\base\BaseObject::__construct()

构造函数。

默认实现执行两件事

  • 使用给定的配置 $config 初始化对象。
  • 调用 init()

如果此方法在子类中被重写,建议

  • 构造函数的最后一个参数是一个配置数组,就像这里的 $config 一样。
  • 在构造函数的末尾调用父实现。
public void __construct ( $config = [] )
$config array

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

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

            
__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()

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

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

  • 由 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);
}

            
addCheck() 公共方法(自版本 2.0.13 起可用)

定义于: yii\db\Command::addCheck()

创建用于向现有表添加检查约束的 SQL 命令。

public $this addCheck ( $name, $table, $expression )
$name string

检查约束的名称。该名称将由方法正确引用。

$table string

将添加检查约束的表。该方法会正确地引用名称。

$expression string

CHECK 约束的 SQL 语句。

返回值 $this

命令对象本身。

                public function addCheck($name, $table, $expression)
{
    $sql = $this->db->getQueryBuilder()->addCheck($name, $table, $expression);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
addColumn() 公共方法

定义于: yii\db\Command::addColumn()

创建用于添加新数据库列的 SQL 命令。

public $this addColumn ( $table, $column, $type )
$table string

将向其添加新列的表。该方法会正确地引用表名。

$column string

新列的名称。该方法会正确地引用名称。

$type string

列类型。将调用 yii\db\QueryBuilder::getColumnType() 将给定的列类型转换为物理类型。例如,string 将转换为 varchar(255),而 string not null 将转换为 varchar(255) not null

返回值 $this

命令对象本身

                public function addColumn($table, $column, $type)
{
    $sql = $this->db->getQueryBuilder()->addColumn($table, $column, $type);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
addCommentOnColumn() 公共方法 (自版本 2.0.8 起可用)

定义于: yii\db\Command::addCommentOnColumn()

构建用于向列添加注释的 SQL 命令。

public $this addCommentOnColumn ( $table, $column, $comment )
$table string

要对其列添加注释的表。该方法会正确地引用表名。

$column string

要对其添加注释的列的名称。该方法会正确地引用列名。

$comment string

要添加的注释文本。该方法会正确地引用注释。

返回值 $this

命令对象本身

                public function addCommentOnColumn($table, $column, $comment)
{
    $sql = $this->db->getQueryBuilder()->addCommentOnColumn($table, $column, $comment);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
addCommentOnTable() 公共方法 (自版本 2.0.8 起可用)

定义于: yii\db\Command::addCommentOnTable()

构建用于向表添加注释的 SQL 命令。

public $this addCommentOnTable ( $table, $comment )
$table string

要对其列添加注释的表。该方法会正确地引用表名。

$comment string

要添加的注释文本。该方法会正确地引用注释。

返回值 $this

命令对象本身

                public function addCommentOnTable($table, $comment)
{
    $sql = $this->db->getQueryBuilder()->addCommentOnTable($table, $comment);
    return $this->setSql($sql);
}

            
addDefaultValue() 公共方法 (自版本 2.0.13 起可用)

定义于: yii\db\Command::addDefaultValue()

创建用于向现有表添加默认值约束的 SQL 命令。

public $this addDefaultValue ( $name, $table, $column, $value )
$name string

默认值约束的名称。该方法会正确地引用名称。

$table string

将添加默认值约束的表。该方法会正确地引用名称。

$column string

将向其添加约束的列的名称。该方法会正确地引用名称。

$value mixed

默认值。

返回值 $this

命令对象本身。

                public function addDefaultValue($name, $table, $column, $value)
{
    $sql = $this->db->getQueryBuilder()->addDefaultValue($name, $table, $column, $value);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
addForeignKey() 公共方法

定义于: yii\db\Command::addForeignKey()

创建用于向现有表添加外键约束的 SQL 命令。

该方法会正确地引用表名和列名。

public $this addForeignKey ( $name, $table, $columns, $refTable, $refColumns, $delete null, $update null )
$name string

外键约束的名称。

$table string

将添加外键约束的表。

$columns 字符串|数组

将向其添加约束的列的名称。如果有多个列,则用逗号分隔。

$refTable string

外键引用的表。

$refColumns 字符串|数组

外键引用的列的名称。如果有多个列,则用逗号分隔。

$delete 字符串|

ON DELETE 选项。大多数 DBMS 支持以下选项:RESTRICT、CASCADE、NO ACTION、SET DEFAULT、SET NULL

$update 字符串|

ON UPDATE 选项。大多数 DBMS 支持以下选项:RESTRICT、CASCADE、NO ACTION、SET DEFAULT、SET NULL

返回值 $this

命令对象本身

                public function addForeignKey($name, $table, $columns, $refTable, $refColumns, $delete = null, $update = null)
{
    $sql = $this->db->getQueryBuilder()->addForeignKey($name, $table, $columns, $refTable, $refColumns, $delete, $update);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
addPrimaryKey() 公共方法

定义于: yii\db\Command::addPrimaryKey()

创建用于向现有表添加主键约束的 SQL 命令。

该方法会正确地引用表名和列名。

public $this addPrimaryKey ( $name, $table, $columns )
$name string

主键约束的名称。

$table string

将添加主键约束的表。

$columns 字符串|数组

主键将由其组成的列的逗号分隔字符串或数组。

返回值 $this

命令对象本身。

                public function addPrimaryKey($name, $table, $columns)
{
    $sql = $this->db->getQueryBuilder()->addPrimaryKey($name, $table, $columns);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
addUnique() 公共方法 (自版本 2.0.13 起可用)

定义于: yii\db\Command::addUnique()

创建用于向现有表添加唯一约束的 SQL 命令。

public $this addUnique ( $name, $table, $columns )
$name string

唯一约束的名称。该方法会正确地引用名称。

$table string

将添加唯一约束的表。该方法会正确地引用名称。

$columns 字符串|数组

将向其添加约束的列的名称。如果有多个列,则用逗号分隔。该方法会正确地引用名称。

返回值 $this

命令对象本身。

                public function addUnique($name, $table, $columns)
{
    $sql = $this->db->getQueryBuilder()->addUnique($name, $table, $columns);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
alterColumn() 公共方法

定义于: yii\db\Command::alterColumn()

创建用于更改列定义的 SQL 命令。

public $this alterColumn ( $table, $column, $type )
$table string

要更改其列的表。该方法会正确地引用表名。

$column string

要更改的列的名称。该方法会正确地引用名称。

$type string

列类型。将调用 yii\db\QueryBuilder::getColumnType() 将给定的列类型转换为物理类型。例如,string 将转换为 varchar(255),而 string not null 将转换为 varchar(255) not null

返回值 $this

命令对象本身

                public function alterColumn($table, $column, $type)
{
    $sql = $this->db->getQueryBuilder()->alterColumn($table, $column, $type);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
attachBehavior() 公共方法

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

将行为附加到此组件。

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

另请参阅 detachBehavior()

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

行为的名称。

$behavior 字符串|数组|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);
    }
}

            
batchInsert() 公共方法

定义于: yii\db\Command::batchInsert()

创建批处理 INSERT 命令。

例如,

$connection->createCommand()->batchInsert('user', ['name', 'age'], [
    ['Tom', 30],
    ['Jane', 20],
    ['Linda', 25],
])->execute();

该方法将正确转义列名,并引用要插入的值。

请注意,每行中的值必须与相应的列名匹配。

另请注意,在调用 execute() 之前,不会执行创建的命令。

public $this batchInsert ( $table, $columns, $rows )
$table string

将插入新行的表。

$columns array

列名

$rows 数组|生成器

要批量插入到表中的行

返回值 $this

命令对象本身

                public function batchInsert($table, $columns, $rows)
{
    $table = $this->db->quoteSql($table);
    $columns = array_map(function ($column) {
        return $this->db->quoteSql($column);
    }, $columns);
    $params = [];
    $sql = $this->db->getQueryBuilder()->batchInsert($table, $columns, $rows, $params);
    $this->setRawSql($sql);
    $this->bindValues($params);
    return $this;
}

            
behaviors() 公共方法

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

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

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

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

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

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

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

public 数组 behaviors ( )
返回值 array

行为配置。

                public function behaviors()
{
    return [];
}

            
bindParam() 公共方法

定义于: yii\db\Command::bindParam()

将参数绑定到要执行的 SQL 语句。

另请参阅 https://php.ac.cn/manual/en/function.PDOStatement-bindParam.php

public $this bindParam ( $name, &$value, $dataType null, $length null, $driverOptions null )
$name 字符串|整数

参数标识符。对于使用命名占位符的预处理语句,这将是 :name 形式的参数名称。对于使用问号占位符的预处理语句,这将是参数的 1 索引位置。

$value mixed

要绑定到 SQL 语句参数的 PHP 变量(通过引用传递)

$dataType 整数|

参数的 SQL 数据类型。如果为 null,则类型由值的 PHP 类型确定。

$length 整数|

数据类型的长度

$driverOptions mixed

驱动程序特定的选项

返回值 $this

当前正在执行的命令

                public function bindParam($name, &$value, $dataType = null, $length = null, $driverOptions = null)
{
    $this->prepare();
    if ($dataType === null) {
        $dataType = $this->db->getSchema()->getPdoType($value);
    }
    if ($length === null) {
        $this->pdoStatement->bindParam($name, $value, $dataType);
    } elseif ($driverOptions === null) {
        $this->pdoStatement->bindParam($name, $value, $dataType, $length);
    } else {
        $this->pdoStatement->bindParam($name, $value, $dataType, $length, $driverOptions);
    }
    $this->params[$name] = &$value;
    return $this;
}

            
bindPendingParams() 受保护方法

绑定通过 bindValue()bindValues() 注册的挂起参数。

请注意,此方法需要一个活动的 $pdoStatement

protected void bindPendingParams ( )

                protected function bindPendingParams()
{
    $paramsPassedByReference = [];
    foreach ($this->pendingParams as $name => $value) {
        if (\PDO::PARAM_STR === $value[1]) {
            $paramsPassedByReference[$name] = $value[0];
            $this->pdoStatement->bindParam($name, $paramsPassedByReference[$name], $value[1], strlen($value[0]));
        } else {
            $this->pdoStatement->bindValue($name, $value[0], $value[1]);
        }
    }
    $this->pendingParams = [];
}

            
bindValue() 公共方法
public $this bindValue ( $name, $value, $dataType null )
$name 字符串|整数

参数标识符。对于使用命名占位符的预处理语句,这将是 :name 形式的参数名称。对于使用问号占位符的预处理语句,这将是参数的 1 索引位置。

$value mixed

要绑定到参数的值

$dataType 整数|

参数的 SQL 数据类型。如果为 null,则类型由值的 PHP 类型确定。

返回值 $this

当前正在执行的命令

                public function bindValue($name, $value, $dataType = null)
{
    if ($dataType === null) {
        $dataType = $this->db->getSchema()->getPdoType($value);
    }
    $this->pendingParams[$name] = [$value, $dataType];
    $this->params[$name] = $value;
    return $this;
}

            
bindValues() 公共方法

定义于: yii\db\Command::bindValues()

将值列表绑定到相应的参数。

这类似于 bindValue(),只是它一次绑定多个值。请注意,每个值的 SQL 数据类型由其 PHP 类型确定。

public $this bindValues ( $values )
$values array

要绑定的值。这必须以关联数组的形式给出,其中数组键是参数名称,数组值是相应的参数值,例如 [':name' => 'John', ':age' => 25]。默认情况下,每个值的 PDO 类型由其 PHP 类型确定。您可以通过使用 yii\db\PdoValue 类显式指定 PDO 类型:new PdoValue(value, type),例如 [':name' => 'John', ':profile' => new PdoValue($profile, \PDO::PARAM_LOB)]

返回值 $this

当前正在执行的命令

                public function bindValues($values)
{
    if (empty($values)) {
        return $this;
    }
    $schema = $this->db->getSchema();
    foreach ($values as $name => $value) {
        if (is_array($value)) { // TODO: Drop in Yii 2.1
            $this->pendingParams[$name] = $value;
            $this->params[$name] = $value[0];
        } elseif ($value instanceof PdoValue) {
            $this->pendingParams[$name] = [$value->getValue(), $value->getType()];
            $this->params[$name] = $value->getValue();
        } else {
            if (version_compare(PHP_VERSION, '8.1.0') >= 0) {
                if ($value instanceof \BackedEnum) {
                    $value = $value->value;
                } elseif ($value instanceof \UnitEnum) {
                    $value = $value->name;
                }
            }
            $type = $schema->getPdoType($value);
            $this->pendingParams[$name] = [$value, $type];
            $this->params[$name] = $value;
        }
    }
    return $this;
}

            
cache() 公共方法

定义于: yii\db\Command::cache()

启用此命令的查询缓存。

public $this cache ( $duration null, $dependency null )
$duration 整数|

此命令的查询结果可以在缓存中保持有效的秒数。如果未设置此值,则将使用 yii\db\Connection::$queryCacheDuration 的值。使用 0 表示缓存数据永远不会过期。

$dependency yii\caching\Dependency|

与缓存的查询结果关联的缓存依赖项。

返回值 $this

命令对象本身

                public function cache($duration = null, $dependency = null)
{
    $this->queryCacheDuration = $duration === null ? $this->db->queryCacheDuration : $duration;
    $this->queryCacheDependency = $dependency;
    return $this;
}

            
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;
}

            
cancel() 公共方法

定义于: yii\db\Command::cancel()

取消 SQL 语句的执行。

此方法主要将 $pdoStatement 设置为 null。

public void cancel ( )

                public function cancel()
{
    $this->pdoStatement = null;
}

            
checkIntegrity() 公共方法

定义于: yii\db\Command::checkIntegrity()

构建用于启用或禁用完整性检查的 SQL 命令。

public $this checkIntegrity ( $check true, $schema '', $table '' )
$check boolean

是否启用或禁用完整性检查。

$schema string

表的模式名称。默认为空字符串,表示当前或默认模式。

$table string

表名。

返回值 $this

命令对象本身

抛出 yii\base\NotSupportedException

如果底层 DBMS 不支持此操作

                public function checkIntegrity($check = true, $schema = '', $table = '')
{
    $sql = $this->db->getQueryBuilder()->checkIntegrity($check, $schema, $table);
    return $this->setSql($sql);
}

            
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();
}

            
createIndex() 公共方法

定义于: yii\db\Command::createIndex()

创建用于创建新索引的 SQL 命令。

public $this createIndex ( $name, $table, $columns, $unique false )
$name string

索引的名称。此方法将对名称进行正确引用。

$table string

将为其创建新索引的表。此方法将对表名进行正确引用。

$columns 字符串|数组

应包含在索引中的列。如果有多个列,请用逗号分隔。此方法将对列名进行正确引用。

$unique boolean

是否在创建的索引上添加 UNIQUE 约束。

返回值 $this

命令对象本身

                public function createIndex($name, $table, $columns, $unique = false)
{
    $sql = $this->db->getQueryBuilder()->createIndex($name, $table, $columns, $unique);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
createTable() 公共方法

定义于: yii\db\Command::createTable()

创建用于创建新数据库表的 SQL 命令。

新表中的列应指定为名称-定义对(例如 'name' => 'string'),其中 name 代表列名,此方法将对其进行正确引用,definition 代表列类型,必须包含抽象的 DB 类型。

将调用 yii\db\QueryBuilder::getColumnType() 方法将抽象列类型转换为物理列类型。例如,string 将转换为 varchar(255),而 string not null 将转换为 varchar(255) not null

如果仅使用定义指定列(例如 'PRIMARY KEY (name, type)'),则它将直接插入到生成的 SQL 中。

用法示例: `php Yii::$app->db->createCommand()->createTable('post', [

'id' => 'pk',
'title' => 'string',
'text' => 'text',
'column_name double precision null default null',

]); `

public $this createTable ( $table, $columns, $options null )
$table string

要创建的表的名称。此方法将对名称进行正确引用。

$columns array

新表中的列(name => definition)。

$options 字符串|

将附加到生成的 SQL 的其他 SQL 片段。

返回值 $this

命令对象本身

                public function createTable($table, $columns, $options = null)
{
    $sql = $this->db->getQueryBuilder()->createTable($table, $columns, $options);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
createView() 公共方法 (自版本 2.0.14 起可用)

定义于: yii\db\Command::createView()

创建 SQL 视图。

public $this createView ( $viewName, $subquery )
$viewName string

要创建的视图的名称。

$subquery string|yii\db\Query

定义视图的 select 语句。这可以是字符串或 yii\db\Query 对象。

返回值 $this

命令对象本身。

                public function createView($viewName, $subquery)
{
    $sql = $this->db->getQueryBuilder()->createView($viewName, $subquery);
    return $this->setSql($sql)->requireTableSchemaRefresh($viewName);
}

            
delete() 公共方法

定义于: yii\db\Command::delete()

创建 DELETE 命令。

例如,

$connection->createCommand()->delete('user', 'status = 0')->execute();

或使用参数绑定条件

$status = 0;
$connection->createCommand()->delete('user', 'status = :status', [':status' => $status])->execute();

此方法将正确转义表和列名。

请注意,在调用 execute() 之前,不会执行创建的命令。

public $this delete ( $table, $condition '', $params = [] )
$table string

将从中删除数据的表。

$condition 字符串|数组

将放在 WHERE 部分的条件。请参阅 yii\db\Query::where() 以了解如何指定条件。

$params array

要绑定到命令的参数

返回值 $this

命令对象本身

                public function delete($table, $condition = '', $params = [])
{
    $sql = $this->db->getQueryBuilder()->delete($table, $condition, $params);
    return $this->setSql($sql)->bindValues($params);
}

            
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);
    }
}

            
dropCheck() 公共方法 (自版本 2.0.13 起可用)

定义于: yii\db\Command::dropCheck()

创建用于删除检查约束的 SQL 命令。

public $this dropCheck ( $name, $table )
$name string

要删除的检查约束的名称。该名称将由方法正确引用。

$table string

要删除其检查约束的表。该名称将由方法正确引用。

返回值 $this

命令对象本身。

                public function dropCheck($name, $table)
{
    $sql = $this->db->getQueryBuilder()->dropCheck($name, $table);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
dropColumn() 公共方法

定义于: yii\db\Command::dropColumn()

创建用于删除数据库列的 SQL 命令。

public $this dropColumn ( $table, $column )
$table string

要删除其列的表。该名称将由方法正确引用。

$column string

要删除的列的名称。该名称将由方法正确引用。

返回值 $this

命令对象本身

                public function dropColumn($table, $column)
{
    $sql = $this->db->getQueryBuilder()->dropColumn($table, $column);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
dropCommentFromColumn() 公共方法 (自版本 2.0.8 起可用)

定义于: yii\db\Command::dropCommentFromColumn()

构建用于从列中删除注释的 SQL 命令。

public $this dropCommentFromColumn ( $table, $column )
$table string

要对其列添加注释的表。该方法会正确地引用表名。

$column string

要对其添加注释的列的名称。该方法会正确地引用列名。

返回值 $this

命令对象本身

                public function dropCommentFromColumn($table, $column)
{
    $sql = $this->db->getQueryBuilder()->dropCommentFromColumn($table, $column);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
dropCommentFromTable() 公共方法 (自版本 2.0.8 起可用)

定义于: yii\db\Command::dropCommentFromTable()

构建用于从表中删除注释的 SQL 命令。

public $this dropCommentFromTable ( $table )
$table string

要对其列添加注释的表。该方法会正确地引用表名。

返回值 $this

命令对象本身

                public function dropCommentFromTable($table)
{
    $sql = $this->db->getQueryBuilder()->dropCommentFromTable($table);
    return $this->setSql($sql);
}

            
dropDefaultValue() 公共方法 (自版本 2.0.13 起可用)

定义于: yii\db\Command::dropDefaultValue()

创建用于删除默认值约束的 SQL 命令。

public $this dropDefaultValue ( $name, $table )
$name string

要删除的默认值约束的名称。该名称将由方法正确引用。

$table string

要删除其默认值约束的表。该名称将由方法正确引用。

返回值 $this

命令对象本身。

                public function dropDefaultValue($name, $table)
{
    $sql = $this->db->getQueryBuilder()->dropDefaultValue($name, $table);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
dropForeignKey() 公共方法

定义于: yii\db\Command::dropForeignKey()

创建用于删除外键约束的 SQL 命令。

public $this dropForeignKey ( $name, $table )
$name string

要删除的外键约束的名称。该名称将由方法正确引用。

$table string

要删除其外键的表。该名称将由方法正确引用。

返回值 $this

命令对象本身

                public function dropForeignKey($name, $table)
{
    $sql = $this->db->getQueryBuilder()->dropForeignKey($name, $table);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
dropIndex() 公共方法

定义于: yii\db\Command::dropIndex()

创建用于删除索引的 SQL 命令。

public $this dropIndex ( $name, $table )
$name string

要删除的索引的名称。该名称将由方法正确引用。

$table string

要删除其索引的表。该名称将由方法正确引用。

返回值 $this

命令对象本身

                public function dropIndex($name, $table)
{
    $sql = $this->db->getQueryBuilder()->dropIndex($name, $table);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
dropPrimaryKey() 公共方法

定义于: yii\db\Command::dropPrimaryKey()

创建用于删除现有表的主键约束的 SQL 命令。

public $this dropPrimaryKey ( $name, $table )
$name string

要删除的主键约束的名称。

$table string

将从中删除主键约束的表。

返回值 $this

命令对象本身

                public function dropPrimaryKey($name, $table)
{
    $sql = $this->db->getQueryBuilder()->dropPrimaryKey($name, $table);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
dropTable() 公共方法

定义于: yii\db\Command::dropTable()

创建用于删除数据库表的 SQL 命令。

public $this dropTable ( $table )
$table string

要删除的表。该名称将由方法正确引用。

返回值 $this

命令对象本身

                public function dropTable($table)
{
    $sql = $this->db->getQueryBuilder()->dropTable($table);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
dropUnique() 公共方法 (自版本 2.0.13 起可用)

定义于: yii\db\Command::dropUnique()

创建用于删除唯一约束的 SQL 命令。

public $this dropUnique ( $name, $table )
$name string

要删除的唯一约束的名称。该名称将由方法正确引用。

$table string

要删除其唯一约束的表。该名称将由方法正确引用。

返回值 $this

命令对象本身。

                public function dropUnique($name, $table)
{
    $sql = $this->db->getQueryBuilder()->dropUnique($name, $table);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
dropView() 公共方法 (自版本 2.0.14 起可用)

定义于: yii\db\Command::dropView()

删除 SQL 视图。

public $this dropView ( $viewName )
$viewName string

要删除的视图的名称。

返回值 $this

命令对象本身。

                public function dropView($viewName)
{
    $sql = $this->db->getQueryBuilder()->dropView($viewName);
    return $this->setSql($sql)->requireTableSchemaRefresh($viewName);
}

            
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);
        }
    }
}

            
execute() 公共方法

定义于: yii\db\Command::execute()

执行 SQL 语句。

此方法仅用于执行非查询 SQL 语句,例如 INSERTDELETEUPDATE SQL。不会返回结果集。

public integer execute ( )
返回值 integer

执行操作影响的行数。

抛出 yii\db\Exception

执行失败

                public function execute()
{
    $sql = $this->getSql();
    list($profile, $rawSql) = $this->logQuery(__METHOD__);
    if ($sql == '') {
        return 0;
    }
    $this->prepare(false);
    try {
        $profile and Yii::beginProfile($rawSql, __METHOD__);
        $this->internalExecute($rawSql);
        $n = $this->pdoStatement->rowCount();
        $profile and Yii::endProfile($rawSql, __METHOD__);
        $this->refreshTableSchema();
        return $n;
    } catch (Exception $e) {
        $profile and Yii::endProfile($rawSql, __METHOD__);
        throw $e;
    }
}

            
executeResetSequence() 公共方法 (自版本 2.0.16 起可用)

定义于: yii\db\Command::executeResetSequence()

执行重置表的 primary key 序列值的数据库命令。

执行的原因是一些数据库(Oracle)需要多个查询才能做到这一点。序列被重置,以便插入的下一行新行的主键具有指定的值或最大现有值 +1。

public void executeResetSequence ( $table, $value null )
$table string

要重置主键序列的表的名称

$value mixed

插入的下一行新行的主键的值。如果未设置此值,则下一行新行的主键将具有最大现有值 +1。

抛出 yii\base\NotSupportedException

如果底层 DBMS 不支持此操作

                public function executeResetSequence($table, $value = null)
{
    return $this->db->getQueryBuilder()->executeResetSequence($table, $value);
}

            
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;
}

            
getCacheKey() 受保护方法 (自版本 2.0.16 起可用)

定义于: yii\db\Command::getCacheKey()

返回查询的缓存键。

protected array getCacheKey ( $method, $fetchMode, $rawSql )
$method string

要调用的 PDOStatement 方法

$fetchMode integer

结果获取模式。有关有效获取模式,请参阅 PHP 手册

$rawSql
返回值 array

缓存键

                protected function getCacheKey($method, $fetchMode, $rawSql)
{
    $params = $this->params;
    ksort($params);
    return [
        __CLASS__,
        $method,
        $fetchMode,
        $this->db->dsn,
        $this->db->username,
        $this->getSql(),
        json_encode($params),
    ];
}

            
getRawSql() 公共方法

定义于: yii\db\Command::getRawSql()

通过将参数值插入到 $sql 中的相应占位符中,返回原始 SQL。

请注意,此方法的返回值主要用于日志记录目的。由于参数占位符的替换不当,此方法很可能返回无效的 SQL。

public string getRawSql ( )
返回值 string

带有参数值的原始 SQL,这些参数值已插入到 $sql 中的相应占位符中。

                public function getRawSql()
{
    if (empty($this->params)) {
        return $this->_sql;
    }
    $params = [];
    foreach ($this->params as $name => $value) {
        if (is_string($name) && strncmp(':', $name, 1)) {
            $name = ':' . $name;
        }
        if (is_string($value) || $value instanceof Expression) {
            $params[$name] = $this->db->quoteValue((string)$value);
        } elseif (is_bool($value)) {
            $params[$name] = ($value ? 'TRUE' : 'FALSE');
        } elseif ($value === null) {
            $params[$name] = 'NULL';
        } elseif (!is_object($value) && !is_resource($value)) {
            $params[$name] = $value;
        }
    }
    if (!isset($params[1])) {
        return preg_replace_callback('#(:\w+)#', function ($matches) use ($params) {
            $m = $matches[1];
            return isset($params[$m]) ? $params[$m] : $m;
        }, $this->_sql);
    }
    $sql = '';
    foreach (explode('?', $this->_sql) as $i => $part) {
        $sql .= (isset($params[$i]) ? $params[$i] : '') . $part;
    }
    return $sql;
}

            
getSql() 公共方法

定义于: yii\db\Command::getSql()

返回此命令的 SQL 语句。

public string getSql ( )
返回值 string

要执行的 SQL 语句

                public function getSql()
{
    return $this->_sql;
}

            
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 布尔型 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);
}

            
init() 公共方法

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

初始化对象。

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

public void init ( )

                public function init()
{
}

            
insert() 公共方法

定义于: yii\db\Command::insert()

创建 INSERT 命令。

例如,

$connection->createCommand()->insert('user', [
    'name' => 'Sam',
    'age' => 30,
])->execute();

此方法将正确转义列名,并将要插入的值绑定。

请注意,在调用 execute() 之前,不会执行创建的命令。

public $this insert ( $table, $columns )
$table string

将插入新行的表。

$columns 数组|yii\db\Query

要插入到表中的列数据(名称 => 值)或 Query 实例以执行 INSERT INTO ... SELECT SQL 语句。从 2.0.11 版本开始,可以传递 Query

返回值 $this

命令对象本身

                public function insert($table, $columns)
{
    $params = [];
    $sql = $this->db->getQueryBuilder()->insert($table, $columns, $params);
    return $this->setSql($sql)->bindValues($params);
}

            
internalExecute() 受保护方法 (自 2.0.14 版本起可用)

定义于: yii\db\Command::internalExecute()

执行预处理语句。

它是 \PDOStatement::execute() 的包装器,用于支持事务和重试处理程序。

protected void internalExecute ( $rawSql )
$rawSql 字符串|

如果已创建,则为 $rawSql。

抛出 yii\db\Exception

如果执行失败。

                protected function internalExecute($rawSql)
{
    $attempt = 0;
    while (true) {
        try {
            if (
                ++$attempt === 1
                && $this->_isolationLevel !== false
                && $this->db->getTransaction() === null
            ) {
                $this->db->transaction(function () use ($rawSql) {
                    $this->internalExecute($rawSql);
                }, $this->_isolationLevel);
            } else {
                $this->pdoStatement->execute();
            }
            break;
        } catch (\Exception $e) {
            $rawSql = $rawSql ?: $this->getRawSql();
            $e = $this->db->getSchema()->convertException($e, $rawSql);
            if ($this->_retryHandler === null || !call_user_func($this->_retryHandler, $e, $attempt)) {
                throw $e;
            }
        }
    }
}

            
logQuery() 受保护方法

定义于: yii\db\Command::logQuery()

如果启用了查询日志记录,则记录当前数据库查询,如果启用了性能分析,则返回性能分析令牌。

protected 数组 logQuery ( $category )
$category string

日志类别。

返回值 array

包含两个元素的数组,第一个是布尔值,表示是否启用性能分析。第二个是如果已创建,则为 $rawSql。

                protected function logQuery($category)
{
    if ($this->db->enableLogging) {
        $rawSql = $this->getRawSql();
        Yii::info($rawSql, $category);
    }
    if (!$this->db->enableProfiling) {
        return [false, isset($rawSql) ? $rawSql : null];
    }
    return [true, isset($rawSql) ? $rawSql : $this->getRawSql()];
}

            
noCache() 公共方法

定义于: yii\db\Command::noCache()

禁用此命令的查询缓存。

public $this noCache ( )
返回值 $this

命令对象本身

                public function noCache()
{
    $this->queryCacheDuration = -1;
    return $this;
}

            
off() 公共方法

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

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

此方法与 on() 相反。

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

另请参阅 on()

public 布尔型 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()

public void 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]);
    }
}

            
prepare() 公共方法

定义于: yii\db\Command::prepare()

准备要执行的 SQL 语句。

对于要多次执行的复杂 SQL 语句,这可能会提高性能。对于带有绑定参数的 SQL 语句,此方法会自动调用。

public void prepare ( $forRead null )
$forRead 布尔型|

此方法是否为读取查询调用。如果为 null,则表示应使用 SQL 语句来确定它是用于读取还是写入。

抛出 yii\db\Exception

如果有任何数据库错误

                public function prepare($forRead = null)
{
    if ($this->pdoStatement) {
        $this->bindPendingParams();
        return;
    }
    $sql = $this->getSql();
    if ($sql === '') {
        return;
    }
    if ($this->db->getTransaction()) {
        // master is in a transaction. use the same connection.
        $forRead = false;
    }
    if ($forRead || $forRead === null && $this->db->getSchema()->isReadQuery($sql)) {
        $pdo = $this->db->getSlavePdo(true);
    } else {
        $pdo = $this->db->getMasterPdo();
    }
    try {
        $this->pdoStatement = $pdo->prepare($sql);
        $this->bindPendingParams();
    } catch (\Exception $e) {
        $message = $e->getMessage() . "\nFailed to prepare SQL: $sql";
        $errorInfo = $e instanceof \PDOException ? $e->errorInfo : null;
        throw new Exception($message, $errorInfo, $e->getCode(), $e);
    } catch (\Throwable $e) {
        $message = $e->getMessage() . "\nFailed to prepare SQL: $sql";
        throw new Exception($message, null, $e->getCode(), $e);
    }
}

            
query() 公共方法

定义于: yii\db\Command::query()

执行 SQL 语句并返回查询结果。

此方法用于执行返回结果集的 SQL 查询,例如 SELECT

public yii\db\DataReader query ( )
返回值 yii\db\DataReader

用于获取查询结果的读取器对象

抛出 yii\db\Exception

执行失败

                public function query()
{
    return $this->queryInternal('');
}

            
queryAll() 公共方法

定义于: yii\db\Command::queryAll()

执行 SQL 语句并立即返回所有行。

public 数组 queryAll ( $fetchMode null )
$fetchMode 整数|

结果获取模式。请参考 PHP 手册 获取有效的获取模式。如果此参数为 null,则将使用 $fetchMode 中设置的值。

返回值 array

查询结果的所有行。每个数组元素都是一个表示数据行的数组。如果查询结果为空,则返回空数组。

抛出 yii\db\Exception

执行失败

                public function queryAll($fetchMode = null)
{
    return $this->queryInternal('fetchAll', $fetchMode);
}

            
queryColumn() 公共方法

定义于: yii\db\Command::queryColumn()

执行 SQL 语句并返回结果的第一列。

当查询结果只需要第一列(即每一行的第一个元素)时,此方法最适用。

public array queryColumn ( )
返回值 array

查询结果的第一列。如果查询结果为空,则返回空数组。

抛出 yii\db\Exception

执行失败

                public function queryColumn()
{
    return $this->queryInternal('fetchAll', \PDO::FETCH_COLUMN);
}

            
queryInternal() 受保护方法

定义于: yii\db\Command::queryInternal()

执行 SQL 语句的实际数据库查询。

protected mixed queryInternal ( $method, $fetchMode null )
$method string

要调用的 PDOStatement 方法

$fetchMode 整数|

结果获取模式。请参考 PHP 手册 获取有效的获取模式。如果此参数为 null,则将使用 $fetchMode 中设置的值。

返回值 mixed

方法执行结果

抛出 yii\db\Exception

如果查询导致任何问题

版本 描述
2.0.1 此方法为受保护方法(之前为私有方法)。

                protected function queryInternal($method, $fetchMode = null)
{
    list($profile, $rawSql) = $this->logQuery('yii\db\Command::query');
    if ($method !== '') {
        $info = $this->db->getQueryCacheInfo($this->queryCacheDuration, $this->queryCacheDependency);
        if (is_array($info)) {
            /* @var $cache \yii\caching\CacheInterface */
            $cache = $info[0];
            $cacheKey = $this->getCacheKey($method, $fetchMode, '');
            $result = $cache->get($cacheKey);
            if (is_array($result) && array_key_exists(0, $result)) {
                Yii::debug('Query result served from cache', 'yii\db\Command::query');
                return $result[0];
            }
        }
    }
    $this->prepare(true);
    try {
        $profile and Yii::beginProfile($rawSql, 'yii\db\Command::query');
        $this->internalExecute($rawSql);
        if ($method === '') {
            $result = new DataReader($this);
        } else {
            if ($fetchMode === null) {
                $fetchMode = $this->fetchMode;
            }
            $result = call_user_func_array([$this->pdoStatement, $method], (array) $fetchMode);
            $this->pdoStatement->closeCursor();
        }
        $profile and Yii::endProfile($rawSql, 'yii\db\Command::query');
    } catch (Exception $e) {
        $profile and Yii::endProfile($rawSql, 'yii\db\Command::query');
        throw $e;
    }
    if (isset($cache, $cacheKey, $info)) {
        $cache->set($cacheKey, [$result], $info[1], $info[2]);
        Yii::debug('Saved query result in cache', 'yii\db\Command::query');
    }
    return $result;
}

            
queryOne() 公共方法

定义于: yii\db\Command::queryOne()

执行 SQL 语句并返回结果的第一行。

当查询结果只需要第一行时,此方法最适用。

public array|false queryOne ( $fetchMode null )
$fetchMode 整数|

结果获取模式。请参考 PHP 手册 获取有效的获取模式。如果此参数为 null,则将使用 $fetchMode 中设置的值。

返回值 array|false

查询结果的第一行(以数组形式表示)。如果查询结果为空,则返回 false。

抛出 yii\db\Exception

执行失败

                public function queryOne($fetchMode = null)
{
    return $this->queryInternal('fetch', $fetchMode);
}

            
queryScalar() 公共方法

定义于: yii\db\Command::queryScalar()

执行 SQL 语句并返回数据第一行中第一列的值。

当查询结果只需要单个值时,此方法最适用。

public string|integer|null|false queryScalar ( )
返回值 string|integer|null|false

查询结果第一行第一列的值。如果没有值,则返回 false。

抛出 yii\db\Exception

执行失败

                public function queryScalar()
{
    $result = $this->queryInternal('fetchColumn', 0);
    if (is_resource($result) && get_resource_type($result) === 'stream') {
        return stream_get_contents($result);
    }
    return $result;
}

            
refreshTableSchema() 受保护方法 (自 2.0.6 版本起可用)

定义于: yii\db\Command::refreshTableSchema()

刷新由 requireTableSchemaRefresh() 标记的表架构。

protected void refreshTableSchema ( )

                protected function refreshTableSchema()
{
    if ($this->_refreshTableName !== null) {
        $this->db->getSchema()->refreshTableSchema($this->_refreshTableName);
    }
}

            
renameColumn() 公共方法

定义于: yii\db\Command::renameColumn()

创建用于重命名列的 SQL 命令。

public $this renameColumn ( $table, $oldName, $newName )
$table string

要重命名其列的表。名称将由方法正确引用。

$oldName string

列的旧名称。名称将由方法正确引用。

$newName string

列的新名称。名称将由方法正确引用。

返回值 $this

命令对象本身

                public function renameColumn($table, $oldName, $newName)
{
    $sql = $this->db->getQueryBuilder()->renameColumn($table, $oldName, $newName);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
renameTable() 公共方法

定义于: yii\db\Command::renameTable()

创建用于重命名数据库表的 SQL 命令。

public $this renameTable ( $table, $newName )
$table string

要重命名的表。名称将由方法正确引用。

$newName string

新的表名。名称将由方法正确引用。

返回值 $this

命令对象本身

                public function renameTable($table, $newName)
{
    $sql = $this->db->getQueryBuilder()->renameTable($table, $newName);
    return $this->setSql($sql)->requireTableSchemaRefresh($table);
}

            
requireTableSchemaRefresh() 受保护方法 (自 2.0.6 版本起可用)

定义于: yii\db\Command::requireTableSchemaRefresh()

标记在命令执行后要刷新的指定表架构。

protected $this requireTableSchemaRefresh ( $name )
$name string

表的名称,其架构应刷新。

返回值 $this

此命令实例

                protected function requireTableSchemaRefresh($name)
{
    $this->_refreshTableName = $name;
    return $this;
}

            
requireTransaction() 受保护方法 (自 2.0.14 版本起可用)

定义于: yii\db\Command::requireTransaction()

标记命令在事务中执行。

protected $this requireTransaction ( $isolationLevel null )
$isolationLevel 字符串|

此事务要使用的隔离级别。有关详细信息,请参阅 yii\db\Transaction::begin()

返回值 $this

此命令实例。

                protected function requireTransaction($isolationLevel = null)
{
    $this->_isolationLevel = $isolationLevel;
    return $this;
}

            
reset() 受保护方法 (自 2.0.13 版本起可用)

定义于: yii\db\Command::reset()

将命令属性重置为其初始状态。

protected void reset ( )

                protected function reset()
{
    $this->_sql = null;
    $this->pendingParams = [];
    $this->params = [];
    $this->_refreshTableName = null;
    $this->_isolationLevel = false;
}

            
resetSequence() 公共方法

定义于: yii\db\Command::resetSequence()

创建用于重置表的 primary key 序列值的 SQL 命令。

序列将被重置,以便插入的下一行新行的主键具有指定的值或最大现有值 +1。

public $this resetSequence ( $table, $value null )
$table string

要重置其主键序列的表的名称

$value mixed

插入的下一行新行的主键的值。如果未设置此值,则下一行新行的主键将具有最大现有值 +1。

返回值 $this

命令对象本身

抛出 yii\base\NotSupportedException

如果底层 DBMS 不支持此操作

                public function resetSequence($table, $value = null)
{
    $sql = $this->db->getQueryBuilder()->resetSequence($table, $value);
    return $this->setSql($sql);
}

            
setRawSql() 公共方法 (自 2.0.13 版本起可用)

定义于: yii\db\Command::setRawSql()

指定要执行的 SQL 语句。SQL 语句不会以任何方式修改。

先前的 SQL(如果有)将被丢弃,并且 $params 也将被清除。有关详细信息,请参阅 reset()

另请参阅

public $this setRawSql ( $sql )
$sql string

要设置的 SQL 语句。

返回值 $this

此命令实例

                public function setRawSql($sql)
{
    if ($sql !== $this->_sql) {
        $this->cancel();
        $this->reset();
        $this->_sql = $sql;
    }
    return $this;
}

            
setRetryHandler() 受保护方法 (自版本 2.0.14 起可用)

定义于: yii\db\Command::setRetryHandler()

设置一个可调用对象(例如匿名函数),当执行命令时抛出 yii\db\Exception 时调用该对象。可调用对象的签名应为

function (\yii\db\Exception $e, $attempt)
{
    // return true or false (whether to retry the command or rethrow $e)
}

此回调函数将接收抛出的数据库异常和当前尝试(执行命令)的次数,从 1 开始。

protected $this setRetryHandler ( callable $handler )
$handler 可调用

用于处理数据库异常的 PHP 回调函数。

返回值 $this

此命令实例。

                protected function setRetryHandler(callable $handler)
{
    $this->_retryHandler = $handler;
    return $this;
}

            
setSql() 公共方法

定义于: yii\db\Command::setSql()

指定要执行的 SQL 语句。SQL 语句将使用 yii\db\Connection::quoteSql() 进行引用。

先前的 SQL(如果有)将被丢弃,并且 $params 也将被清除。有关详细信息,请参阅 reset()

另请参阅

public $this setSql ( $sql )
$sql string

要设置的 SQL 语句。

返回值 $this

此命令实例

                public function setSql($sql)
{
    if ($sql !== $this->_sql) {
        $this->cancel();
        $this->reset();
        $this->_sql = $this->db->quoteSql($sql);
    }
    return $this;
}

            
trigger() 公共方法

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

触发一个事件。

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

public void 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);
}

            
truncateTable() 公共方法

定义于: yii\db\Command::truncateTable()

创建一个用于截断数据库表的 SQL 命令。

public $this truncateTable ( $table )
$table string

要截断的表。此方法将正确地引用表名。

返回值 $this

命令对象本身

                public function truncateTable($table)
{
    $sql = $this->db->getQueryBuilder()->truncateTable($table);
    return $this->setSql($sql);
}

            
update() 公共方法

定义于: yii\db\Command::update()

创建一个 UPDATE 命令。

例如,

$connection->createCommand()->update('user', ['status' => 1], 'age > 30')->execute();

或使用参数绑定条件

$minAge = 30;
$connection->createCommand()->update('user', ['status' => 1], 'age > :minAge', [':minAge' => $minAge])->execute();

此方法将正确地转义列名并将要更新的值绑定。

请注意,在调用 execute() 之前,不会执行创建的命令。

public $this update ( $table, $columns, $condition '', $params = [] )
$table string

要更新的表。

$columns array

要更新的列数据(名称 => 值)。

$condition 字符串|数组

将放在 WHERE 部分的条件。请参阅 yii\db\Query::where() 以了解如何指定条件。

$params array

要绑定到命令的参数

返回值 $this

命令对象本身

                public function update($table, $columns, $condition = '', $params = [])
{
    $sql = $this->db->getQueryBuilder()->update($table, $columns, $condition, $params);
    return $this->setSql($sql)->bindValues($params);
}

            
upsert() 公共方法 (自版本 2.0.14 起可用)

定义于: yii\db\Command::upsert()

创建一个命令,如果数据库表中不存在行(匹配唯一约束),则插入行,否则更新行。

例如,

$sql = $queryBuilder->upsert('pages', [
    'name' => 'Front page',
    'url' => 'https://example.com/', // url is unique
    'visits' => 0,
], [
    'visits' => new \yii\db\Expression('visits + 1'),
], $params);

此方法将正确转义表和列名。

public $this upsert ( $table, $insertColumns, $updateColumns true, $params = [] )
$table string

将向其中插入/更新新行的表。

$insertColumns 数组|yii\db\Query

要插入表中的列数据(名称 => 值),或 yii\db\Query 的实例,用于执行 INSERT INTO ... SELECT SQL 语句。

$updateColumns array|boolean

如果列数据已存在,则要更新的列数据(名称 => 值)。如果传递 true,则列数据将更新为与插入列数据匹配。如果传递 false,则如果列数据已存在,则不会执行任何更新。

$params array

要绑定到命令的参数。

返回值 $this

命令对象本身。

                public function upsert($table, $insertColumns, $updateColumns = true, $params = [])
{
    $sql = $this->db->getQueryBuilder()->upsert($table, $insertColumns, $updateColumns, $params);
    return $this->setSql($sql)->bindValues($params);
}