class BatchRowIterator implements RecursiveIterator {
/**
- * @var DatabaseBase $db The database to read from
+ * @var IDatabase $db The database to read from
*/
protected $db;
/**
- * @var string $table The name of the table to read from
+ * @var string|array $table The name or names of the table to read from
*/
protected $table;
* @var array $conditions Array of strings containing SQL conditions
* to add to the query
*/
- protected $conditions = array();
+ protected $conditions = [];
/**
* @var array $joinConditions
*/
- protected $joinConditions = array();
+ protected $joinConditions = [];
/**
* @var array $fetchColumns List of column names to select from the
- * table suitable for use with DatabaseBase::select()
+ * table suitable for use with IDatabase::select()
*/
protected $fetchColumns;
/**
* @var array $current The current iterator value
*/
- private $current = array();
+ private $current = [];
/**
* @var integer key 0-indexed number of pages fetched since self::reset()
private $key;
/**
- * @param DatabaseBase $db The database to read from
- * @param string $table The name of the table to read from
+ * @var array Additional query options
+ */
+ protected $options = [];
+
+ /**
+ * @param IDatabase $db The database to read from
+ * @param string|array $table The name or names of the table to read from
* @param string|array $primaryKey The name or names of the primary key columns
* @param integer $batchSize The number of rows to fetch per iteration
- * @throws MWException
+ * @throws InvalidArgumentException
*/
- public function __construct( DatabaseBase $db, $table, $primaryKey, $batchSize ) {
+ public function __construct( IDatabase $db, $table, $primaryKey, $batchSize ) {
if ( $batchSize < 1 ) {
- throw new MWException( 'Batch size must be at least 1 row.' );
+ throw new InvalidArgumentException( 'Batch size must be at least 1 row.' );
}
$this->db = $db;
$this->table = $table;
}
/**
- * @param array $condition Query conditions suitable for use with
- * DatabaseBase::select
+ * @param array $conditions Query conditions suitable for use with
+ * IDatabase::select
*/
public function addConditions( array $conditions ) {
$this->conditions = array_merge( $this->conditions, $conditions );
}
/**
- * @param array $condition Query join conditions suitable for use
- * with DatabaseBase::select
+ * @param array $options Query options suitable for use with
+ * IDatabase::select
+ */
+ public function addOptions( array $options ) {
+ $this->options = array_merge( $this->options, $options );
+ }
+
+ /**
+ * @param array $conditions Query join conditions suitable for use
+ * with IDatabase::select
*/
public function addJoinConditions( array $conditions ) {
$this->joinConditions = array_merge( $this->joinConditions, $conditions );
/**
* @param array $columns List of column names to select from the
- * table suitable for use with DatabaseBase::select()
+ * table suitable for use with IDatabase::select()
*/
public function setFetchColumns( array $columns ) {
// If it's not the all column selector merge in the primary keys we need
* @return array Map of primary key column to value within the row
*/
public function extractPrimaryKeys( $row ) {
- $pk = array();
- foreach ( $this->primaryKey as $column ) {
- $pk[$column] = $row->$column;
+ $pk = [];
+ foreach ( $this->primaryKey as $alias => $column ) {
+ $name = is_numeric( $alias ) ? $column : $alias;
+ $pk[$name] = $row->{$name};
}
return $pk;
}
*/
public function rewind() {
$this->key = -1; // self::next() will turn this into 0
- $this->current = array();
+ $this->current = [];
$this->next();
}
/**
- * @return boolean True when the iterator is in a valid state
+ * @return bool True when the iterator is in a valid state
*/
public function valid() {
return (bool)$this->current;
}
/**
- * @return boolean True when this result set has rows
+ * @return bool True when this result set has rows
*/
public function hasChildren() {
return $this->current && count( $this->current );
$this->fetchColumns,
$this->buildConditions(),
__METHOD__,
- array(
+ [
'LIMIT' => $this->batchSize,
'ORDER BY' => $this->orderBy,
- ),
+ ] + $this->options,
$this->joinConditions
);
* `=` conditions while the final key uses a `>` condition
*
* Example output:
- * array( '( foo = 42 AND bar > 7 ) OR ( foo > 42 )' )
+ * [ '( foo = 42 AND bar > 7 ) OR ( foo > 42 )' ]
*
* @return array The SQL conditions necessary to select the next set
* of rows in the batched query
}
$maxRow = end( $this->current );
- $maximumValues = array();
- foreach ( $this->primaryKey as $column ) {
- $maximumValues[$column] = $this->db->addQuotes( $maxRow->$column );
+ $maximumValues = [];
+ foreach ( $this->primaryKey as $alias => $column ) {
+ $name = is_numeric( $alias ) ? $column : $alias;
+ $maximumValues[$column] = $this->db->addQuotes( $maxRow->{$name} );
}
- $pkConditions = array();
+ $pkConditions = [];
// For example: If we have 3 primary keys
// first run through will generate
// col1 = 4 AND col2 = 7 AND col3 > 1
$keys = array_keys( $quotedMaximumValues );
$lastColumn = end( $keys );
$lastValue = array_pop( $quotedMaximumValues );
- $conditions = array();
+ $conditions = [];
foreach ( $quotedMaximumValues as $column => $value ) {
$conditions[] = "$column = $value";
}