PHP Class yii\mongodb\BatchQueryResult

You usually do not instantiate BatchQueryResult directly. Instead, you obtain it by calling [[Query::batch()]] or [[Query::each()]]. Because BatchQueryResult implements the Iterator interface, you can iterate it to obtain a batch of data in each iteration. For example, php $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) { }
Since: 2.1
Author: Paul Klimov ([email protected])
Inheritance: extends yii\base\Object, implements Iterator
Mostrar archivo Open project: yiisoft/yii2-mongodb Class Usage Examples

Public Properties

Property Type Description
$batchSize the number of rows to be returned in each batch.
$db the MongoDB connection to be used when performing batch query. If null, the "mongodb" application component will be used.
$each whether to return a single row during each iteration. If false, a whole batch of rows will be returned in each iteration.
$query the query object associated with this batch query. Do not modify this property directly unless after BatchQueryResult::reset is called explicitly.

Public Methods

Method Description
current ( ) : mixed Returns the current dataset.
key ( ) : integer Returns the index of the current dataset.
next ( ) Moves the internal pointer to the next dataset.
reset ( ) Resets the batch query.
rewind ( ) Resets the iterator to the initial state.
valid ( ) : boolean Returns whether there is a valid dataset at the current position.

Protected Methods

Method Description
fetchData ( ) : array Fetches the next batch of data.

Method Details

current() public method

This method is required by the interface Iterator.
public current ( ) : mixed
return mixed the current dataset.

fetchData() protected method

Fetches the next batch of data.
protected fetchData ( ) : array
return array the data fetched

key() public method

This method is required by the interface Iterator.
public key ( ) : integer
return integer the index of the current row.

next() public method

This method is required by the interface Iterator.
public next ( )

reset() public method

This method will clean up the existing batch query so that a new batch query can be performed.
public reset ( )

rewind() public method

This method is required by the interface Iterator.
public rewind ( )

valid() public method

This method is required by the interface Iterator.
public valid ( ) : boolean
return boolean whether there is a valid dataset at the current position.

Property Details

$batchSize public_oe property

the number of rows to be returned in each batch.
public $batchSize

$db public_oe property

the MongoDB connection to be used when performing batch query. If null, the "mongodb" application component will be used.
public $db

$each public_oe property

whether to return a single row during each iteration. If false, a whole batch of rows will be returned in each iteration.
public $each

$query public_oe property

the query object associated with this batch query. Do not modify this property directly unless after BatchQueryResult::reset is called explicitly.
public $query