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 執行批次查詢時要使用的 DB 連線。如果為 null，將使用 "db" 應用程式組件。 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() 檢查屬性是否已設定，即已定義且非 null。 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 公開屬性

執行批次查詢時要使用的 DB 連線。如果為 null，將使用 "db" 應用程式組件。

public yii\db\Connection|null $db = null
$each 公開屬性

是否在每次迭代期間傳回單列。如果為 false，則每次迭代將傳回一整批列。

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

檢查屬性是否已設定，即已定義且非 null。

此方法將依以下順序檢查並採取相應的動作：

  • setter 定義的屬性：傳回屬性是否已設定
  • 行為的屬性：傳回屬性是否已設定
  • 針對不存在的屬性傳回 false

請勿直接呼叫此方法，因為它是 PHP 魔術方法，當執行 isset($component->property) 時，將會隱式地呼叫它。

另請參閱 https://php.dev.org.tw/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.dev.org.tw/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 string|array|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 array behaviors ( )
return 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

是否將行為的屬性視為此組件的屬性
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 boolean 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 string className ( )
return string

此類別的完整限定名稱。

 

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

傳回目前的資料集。

此方法為 Iterator 介面所要求。

public mixed current ( )
return mixed

目前的資料集。

 

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

定義於： yii\base\Component::detachBehavior()

從組件分離行為。

將會調用行為的 yii\base\Behavior::detach() 方法。

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

行為的名稱。
return 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() public method

Defined in: yii\base\Component::detachBehaviors()

從組件分離所有行為。

public void detachBehaviors ( )

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

Defined in: 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 method

提取下一批資料。

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() public method

Defined in: yii\base\Component::getBehavior()

傳回指定的行為物件。

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

行為名稱
return yii\base\Behavior|null

行為物件，如果行為不存在則為 null

 

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

Defined in: yii\base\Component::getBehaviors()

傳回附加到此組件的所有行為。

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

附加到此元件的行為列表

 

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}
getRows() protected method (available since version 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() public method

Defined in: 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() public method

Defined in: 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() public method

Defined in: 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() public method

Defined in: yii\base\BaseObject::init()

初始化物件。

在物件以給定組態初始化後，此方法會在建構函式的結尾被調用。

public void init ( )

                public function init()
{
}
key() public method

傳回目前資料集的索引。

此方法為 Iterator 介面所要求。

public integer key ( )
return integer

當前列的索引。

 

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

將內部指標移動到下一個資料集。

此方法為 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() public method

Defined in: 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() public method

Defined in: 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]);
    }
}
reset() public method

重設批次查詢。

此方法將清理現有的批次查詢，以便可以執行新的批次查詢。

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() public method

將迭代器重設為初始狀態。

此方法為 Iterator 介面所要求。

public void rewind ( )

                #[\ReturnTypeWillChange]
public function rewind()
{
    $this->reset();
    $this->next();
}
trigger() public method

Defined in: 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() public method

傳回在目前位置是否有有效的資料集。

此方法為 Iterator 介面所要求。

public boolean valid ( )
return boolean

在目前位置是否有有效的資料集。

 

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

事件詳情

隱藏繼承的屬性

EVENT_FINISH event of type yii\db\Event (available since version 2.0.41)

當最後一批資料被擷取時觸發的事件。

EVENT_RESET event of type yii\db\Event (available since version 2.0.41)

當批次查詢被重設時觸發的事件。

另請參閱 reset()。