0 关注者

类 yii\db\BatchQueryResult

所有类 | 属性 | 方法 | 事件 | 常量
继承yii\db\BatchQueryResult » yii\base\Component » yii\base\BaseObject
实现Iterator, yii\base\Configurable
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/db/BatchQueryResult.php

BatchQueryResult 表示批处理查询，您可以在其中批处理检索数据。

通常您不会直接实例化 BatchQueryResult。相反，您可以通过调用 yii\db\Query::batch() 或 yii\db\Query::each() 来获取它。因为 BatchQueryResult 实现了 Iterator 接口，您可以迭代它以在每次迭代中获取一批数据。例如：

$query = (new Query)->from('user');
foreach ($query->batch() as $i => $users) {
    // $users represents the rows in the $i-th batch
}
foreach ($query->each() as $user) {
}

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$batchSize integer 每次批处理返回的行数。 yii\db\BatchQueryResult
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$db yii\db\Connection|null 执行批处理查询时要使用的数据库连接。 yii\db\BatchQueryResult
$each boolean 是否在每次迭代中返回一行。如果为假，则每次迭代将返回一整批行。 yii\db\BatchQueryResult
$query yii\db\Query 与此批处理查询关联的查询对象。 yii\db\BatchQueryResult

公共方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法在通过克隆现有对象创建对象后被调用。 yii\base\Component
__construct() 构造函数。 yii\base\BaseObject
__destruct() 析构函数。 yii\db\BatchQueryResult
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置，即已定义且不为空。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
__wakeup() 反序列化已禁用，以防止在应用程序在用户输入（包含经过特殊设计的字符串）上调用 unserialize() 时发生远程代码执行。 yii\db\BatchQueryResult
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
behaviors() 返回此组件应表现为的行为列表。 yii\base\Component
canGetProperty() 返回一个值，指示是否可以读取属性。 yii\base\Component
canSetProperty() 返回一个值，指示是否可以设置属性。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
current() 返回当前数据集。 yii\db\BatchQueryResult
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
key() 返回当前数据集的索引。 yii\db\BatchQueryResult
next() 将内部指针移动到下一个数据集。 yii\db\BatchQueryResult
off() 从该组件分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
reset() 重置批处理查询。 yii\db\BatchQueryResult
rewind() 将迭代器重置为初始状态。 yii\db\BatchQueryResult
trigger() 触发事件。 yii\base\Component
valid() 返回当前位置是否存在有效数据集。 yii\db\BatchQueryResult

受保护的方法

隐藏继承的方法

方法 描述 定义于
fetchData() 获取下一批数据。 yii\db\BatchQueryResult
getRows() 读取并收集批处理的行 yii\db\BatchQueryResult

事件

隐藏继承的事件

事件 类型 描述 定义于
EVENT_FINISH yii\db\Event 在获取最后一批后触发的事件。（从版本 2.0.41 开始可用） yii\db\BatchQueryResult
EVENT_RESET yii\db\Event 重置批处理查询时触发的事件。（从版本 2.0.41 开始可用） yii\db\BatchQueryResult

常量

隐藏继承的常量

常量 值 描述 定义于
MSSQL_NO_MORE_ROWS_ERROR_CODE -13 MSSQL 错误代码，用于在最后一批大小小于指定的批处理大小时抛出的异常 yii\db\BatchQueryResult

属性详细信息

隐藏继承的属性

$batchSize 公共属性

每次批处理返回的行数。

public integer $batchSize = 100
$db 公共属性

执行批处理查询时要使用的数据库连接。如果为 null，将使用 "db" 应用程序组件。

public yii\db\Connection|null $db = null
$each 公共属性

是否在每次迭代中返回一行。如果为假，则每次迭代将返回一整批行。

public boolean $each = false
$query 公共属性

与该批次查询关联的查询对象。除非在显式调用 reset() 后，否则不要直接修改此属性。

public yii\db\Query $query = null

方法详情

隐藏继承的方法

__call() 公共方法

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

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

此方法将检查是否有任何附加的行为具有命名的函数，如果可用，将执行该函数。

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

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

方法名称
$params array

方法参数
return mixed

方法返回值
throws 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();
}
__destruct() 公共方法

析构函数。

public void __destruct ( )

                public function __destruct()
{
    // make sure cursor is closed
    $this->reset();
}
__get() 公共方法

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

返回组件属性的值。

此方法将按照以下顺序检查并相应地执行

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

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

另见 __set()。

public mixed __get ( $name )
$name string

属性名称
return mixed

属性值或行为属性的值
throws yii\base\UnknownPropertyException

如果属性未定义
throws 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

属性名称或事件名称
return 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

属性值
throws yii\base\UnknownPropertyException

如果属性未定义
throws 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

属性名称
throws 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);
}
__wakeup() 公共方法 (版本 2.0.38 及更高版本可用)

反序列化已禁用，以防止在应用程序在用户输入（包含经过特殊设计的字符串）上调用 unserialize() 时发生远程代码执行。

另见 https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-15148。

public void __wakeup ( )

                public function __wakeup()
{
    throw new \BadMethodCallException('Cannot unserialize ' . __CLASS__);
}
attachBehavior() 公共方法

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

将行为附加到此组件。

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

另请参阅 detachBehavior().

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

行为的名称。
$behavior 字符串|数组|yii\base\Behavior

行为配置。可以是以下之一
return 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 数组 behaviors ( )
return array

行为配置。

 

                public function behaviors()
{
    return [];
}
canGetProperty() 公共方法

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

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

如果可以读取属性

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

另请参阅 canSetProperty().

public 布尔值 canGetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name string

属性名称
$checkVars boolean

是否将成员变量视为属性
$checkBehaviors boolean

是否将行为的属性视为此组件的属性
return 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 布尔值 canSetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name string

属性名称
$checkVars boolean

是否将成员变量视为属性
$checkBehaviors boolean

是否将行为的属性视为此组件的属性
return 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 字符串 className ( )
return string

此类的完全限定名称。

 

                public static function className()
{
    return get_called_class();
}
current() 公共方法

返回当前数据集。

此方法是 Iterator 接口所必需的。

public 混合 current ( )
return mixed

当前数据集。

 

                #[\ReturnTypeWillChange]
public function current()
{
    return $this->_value;
}
detachBehavior() 公共方法

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

从组件分离行为。

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

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

行为的名称。
return yii\base\Behavior|空值

已分离的行为。如果行为不存在，则为 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);
        }
    }
}
fetchData() 受保护方法

获取下一批数据。

protected array fetchData ( )
return array

获取到的数据
throws yii\db\Exception 

                protected function fetchData()
{
    if ($this->_dataReader === null) {
        $this->_dataReader = $this->query->createCommand($this->db)->query();
    }
    $rows = $this->getRows();
    return $this->query->populate($rows);
}
getBehavior() 公共方法

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

返回命名的行为对象。

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

行为名称
return yii\base\Behavior|空值

行为对象，如果行为不存在则为 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 ( )
return yii\base\Behavior[]

附加到此组件的行为列表

 

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}
getRows() 受保护方法 (自版本 2.0.23 起可用)

读取并收集批处理的行

protected array getRows ( )

                protected function getRows()
{
    $rows = [];
    $count = 0;
    try {
        while ($count++ < $this->batchSize) {
            if ($row = $this->_dataReader->read()) {
                $rows[] = $row;
            } else {
                // we've reached the end
                $this->trigger(self::EVENT_FINISH);
                break;
            }
        }
    } catch (\PDOException $e) {
        $errorCode = isset($e->errorInfo[1]) ? $e->errorInfo[1] : null;
        if ($this->getDbDriverName() !== 'sqlsrv' || $errorCode !== self::MSSQL_NO_MORE_ROWS_ERROR_CODE) {
            throw $e;
        }
    }
    return $rows;
}
hasEventHandlers() 公共方法

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

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

public boolean hasEventHandlers ( $name )
$name string

事件名称
return 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

是否将行为的方法视为此组件的方法
return 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

是否将行为的属性视为此组件的属性
return 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()
{
}
key() 公共方法

返回当前数据集的索引。

此方法是 Iterator 接口所必需的。

public integer key ( )
return integer

当前行的索引。

 

                #[\ReturnTypeWillChange]
public function key()
{
    return $this->_key;
}
next() 公共方法

将内部指针移动到下一个数据集。

此方法是 Iterator 接口所必需的。

public void next ( )

                #[\ReturnTypeWillChange]
public function next()
{
    if ($this->_batch === null || !$this->each || $this->each && next($this->_batch) === false) {
        $this->_batch = $this->fetchData();
        reset($this->_batch);
    }
    if ($this->each) {
        $this->_value = current($this->_batch);
        if ($this->query->indexBy !== null) {
            $this->_key = key($this->_batch);
        } elseif (key($this->_batch) !== null) {
            $this->_key = $this->_key === null ? 0 : $this->_key + 1;
        } else {
            $this->_key = null;
        }
    } else {
        $this->_value = $this->_batch;
        $this->_key = $this->_key === null ? 0 : $this->_key + 1;
    }
}
off() 公共方法

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

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

此方法与 on() 相反。

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

另请参阅 on()。

public boolean off ( $name, $handler = null )
$name string

事件名称
$handler callable|null

要删除的事件处理程序。如果为 null，则将删除附加到指定事件的所有处理程序。
return 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 callable

事件处理程序
$data mixed

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

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

 

                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]);
    }
}
reset() 公共方法

重置批处理查询。

此方法将清除现有的批量查询，以便可以执行新的批量查询。

public void reset ( )

                public function reset()
{
    if ($this->_dataReader !== null) {
        $this->_dataReader->close();
    }
    $this->_dataReader = null;
    $this->_batch = null;
    $this->_value = null;
    $this->_key = null;
    $this->trigger(self::EVENT_RESET);
}
rewind() 公共方法

将迭代器重置为初始状态。

此方法是 Iterator 接口所必需的。

public void rewind ( )

                #[\ReturnTypeWillChange]
public function rewind()
{
    $this->reset();
    $this->next();
}
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);
}
valid() 公共方法

返回当前位置是否存在有效数据集。

此方法是 Iterator 接口所必需的。

public boolean valid ( )
return boolean

当前位置是否存在有效的数据集。

 

                #[\ReturnTypeWillChange]
public function valid()
{
    return !empty($this->_batch);
}

事件详情

隐藏继承的属性

EVENT_FINISH 类型为 yii\db\Event 的事件（自版本 2.0.41 起可用）

在获取最后一个批次时触发的事件。

EVENT_RESET 类型为 yii\db\Event 的事件（自版本 2.0.41 起可用）

在重置批量查询时触发的事件。

另见 reset().