Inheritance diagram for BatchRowIterator:

Collaboration diagram for BatchRowIterator:

Public Member Functions
	__construct (IDatabase $db, $table, $primaryKey, $batchSize)

	addConditions (array $conditions)

	addJoinConditions (array $conditions)

	addOptions (array $options)

	current ()

	extractPrimaryKeys ( $row)
	Extracts the primary key(s) from a database row.

	getChildren ()

	hasChildren ()

	key ()

	next ()
	Fetch the next set of rows from the database.

	rewind ()
	Reset the iterator to the begining of the table.

	setFetchColumns (array $columns)

	valid ()

Protected Member Functions
	buildConditions ()
	Uses the primary key list and the maximal result row from the previous iteration to build an SQL condition sufficient for selecting the next page of results.

	buildGreaterThanCondition (array $quotedMaximumValues)
	Given an array of column names and their maximum value generate an SQL condition where all keys except the last match $quotedMaximumValues exactly and the last column is greater than the matching value in $quotedMaximumValues.

Protected Attributes
	$batchSize

	$conditions = []

	$db

	$fetchColumns

	$joinConditions = []

array	$options = []
	Additional query options.

	$orderBy

	$primaryKey

	$table

Private Attributes
	$current = []

integer	$key
	key 0-indexed number of pages fetched since self::reset()

Detailed Description

Definition at line 26 of file BatchRowIterator.php.

Constructor & Destructor Documentation

◆ __construct()

BatchRowIterator::__construct	(	IDatabase	$db,
			$table,
			$primaryKey,
			$batchSize
	)

Parameters

IDatabase	$db	The database to read from
string \| array	$table	The name or names of the table to read from
string \| array	$primaryKey	The name or names of the primary key columns
integer	$batchSize	The number of rows to fetch per iteration

Exceptions

InvalidArgumentException

Definition at line 92 of file BatchRowIterator.php.

References $batchSize, $db, $primaryKey, $table, array(), and table.

Member Function Documentation

◆ addConditions()

BatchRowIterator::addConditions ( array $conditions )

Parameters

array $conditions Query conditions suitable for use with IDatabase::select

Definition at line 108 of file BatchRowIterator.php.

References conditions.

◆ addJoinConditions()

BatchRowIterator::addJoinConditions ( array $conditions )

Parameters

array $conditions Query join conditions suitable for use with IDatabase::select

Definition at line 124 of file BatchRowIterator.php.

References $conditions.

◆ addOptions()

BatchRowIterator::addOptions ( array $options )

Parameters

array $options Query options suitable for use with IDatabase::select

Definition at line 116 of file BatchRowIterator.php.

References options().

◆ buildConditions()

BatchRowIterator::buildConditions ( )

protected

Uses the primary key list and the maximal result row from the previous iteration to build an SQL condition sufficient for selecting the next page of results.

All except the final key use = conditions while the final key uses a > condition

Example output: [ '( foo = 42 AND bar > 7 ) OR ( foo > 42 )' ]

Returns: array The SQL conditions necessary to select the next set of rows in the batched query

Definition at line 238 of file BatchRowIterator.php.

References $name, and as.

◆ buildGreaterThanCondition()

BatchRowIterator::buildGreaterThanCondition ( array $quotedMaximumValues )

protected

Given an array of column names and their maximum value generate an SQL condition where all keys except the last match $quotedMaximumValues exactly and the last column is greater than the matching value in $quotedMaximumValues.

Parameters

array $quotedMaximumValues The maximum values quoted with $this->db->addQuotes()

Returns: string An SQL condition that will select rows where all columns match the maximum value exactly except the last column which must be greater than the provided maximum value

Definition at line 281 of file BatchRowIterator.php.

References $keys, $value, and as.

◆ current()

BatchRowIterator::current ( )

Returns: array The most recently fetched set of rows from the database

Definition at line 162 of file BatchRowIterator.php.

◆ extractPrimaryKeys()

BatchRowIterator::extractPrimaryKeys ( $row )

Extracts the primary key(s) from a database row.

Parameters

stdClass $row An individual database row from this iterator

Returns: array Map of primary key column to value within the row

Definition at line 150 of file BatchRowIterator.php.

References $name, and as.

◆ getChildren()

BatchRowIterator::getChildren ( )

Returns: RecursiveIterator

Definition at line 199 of file BatchRowIterator.php.

◆ hasChildren()

BatchRowIterator::hasChildren ( )

Returns: bool True when this result set has rows

Definition at line 192 of file BatchRowIterator.php.

◆ key()

array $primaryKey The name of the primary BatchRowIterator::key ( )

Returns: integer 0-indexed count of the page number fetched

Definition at line 169 of file BatchRowIterator.php.

◆ next()

BatchRowIterator::next ( )

Fetch the next set of rows from the database.

Definition at line 206 of file BatchRowIterator.php.

References $res, key, options(), and table.

◆ rewind()

BatchRowIterator::rewind ( )

Reset the iterator to the begining of the table.

Definition at line 176 of file BatchRowIterator.php.

References key.

◆ setFetchColumns()

BatchRowIterator::setFetchColumns ( array $columns )

Parameters

array $columns List of column names to select from the table suitable for use with IDatabase::select()

Definition at line 132 of file BatchRowIterator.php.

◆ valid()

BatchRowIterator::valid ( )

Returns: bool True when the iterator is in a valid state

Definition at line 185 of file BatchRowIterator.php.

Member Data Documentation

◆ $batchSize

BatchRowIterator::$batchSize

protected

Definition at line 46 of file BatchRowIterator.php.

Referenced by __construct().

◆ $conditions

BatchRowIterator::$conditions = []

protected

Definition at line 52 of file BatchRowIterator.php.

Referenced by addJoinConditions().

◆ $current

BatchRowIterator::$current = []

private

Definition at line 73 of file BatchRowIterator.php.

◆ $db

BatchRowIterator::$db

protected

Definition at line 31 of file BatchRowIterator.php.

Referenced by __construct().

◆ $fetchColumns

BatchRowIterator::$fetchColumns

protected

Definition at line 63 of file BatchRowIterator.php.

◆ $joinConditions

array BatchRowIterator::$joinConditions = []

protected

Definition at line 57 of file BatchRowIterator.php.

◆ $key

integer BatchRowIterator::$key

private

key 0-indexed number of pages fetched since self::reset()

Definition at line 78 of file BatchRowIterator.php.

◆ $options

array BatchRowIterator::$options = []

protected

Additional query options.

Definition at line 83 of file BatchRowIterator.php.

◆ $orderBy

BatchRowIterator::$orderBy

protected

Definition at line 68 of file BatchRowIterator.php.

◆ $primaryKey

BatchRowIterator::$primaryKey

protected

Definition at line 41 of file BatchRowIterator.php.

Referenced by __construct().

◆ $table

BatchRowIterator::$table

protected

Definition at line 36 of file BatchRowIterator.php.

Referenced by __construct().

The documentation for this class was generated from the following file:

includes/utils/BatchRowIterator.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addConditions()

◆ addJoinConditions()

◆ addOptions()

◆ buildConditions()

◆ buildGreaterThanCondition()

◆ current()

◆ extractPrimaryKeys()

◆ getChildren()

◆ hasChildren()

◆ key()

◆ next()

◆ rewind()

◆ setFetchColumns()

◆ valid()

Member Data Documentation

◆ $batchSize

◆ $conditions

◆ $current

◆ $db

◆ $fetchColumns

◆ $joinConditions

◆ $key

◆ $options

◆ $orderBy

◆ $primaryKey

◆ $table