Merge "Don't hard-code Preferences page name"

[lhc/web/wiklou.git] / includes / utils / BatchRowIterator.php

diff --git a/includes/utils/BatchRowIterator.php b/includes/utils/BatchRowIterator.php
index ef2c14a..60720c8 100644 (file)
--- a/includes/utils/BatchRowIterator.php
+++ b/includes/utils/BatchRowIterator.php
@@ -1,4 +1,7 @@
 <?php
+
+use Wikimedia\Rdbms\IDatabase;
+
 /**
  * Allows iterating a large number of rows in batches transparently.
  * By default when iterated over returns the full query result as an
@@ -41,7 +44,7 @@ class BatchRowIterator implements RecursiveIterator {
        protected $primaryKey;
 
        /**
-        * @var integer $batchSize The number of rows to fetch per iteration
+        * @var int $batchSize The number of rows to fetch per iteration
         */
        protected $batchSize;
 
@@ -73,7 +76,7 @@ class BatchRowIterator implements RecursiveIterator {
        private $current = [];
 
        /**
-        * @var integer key 0-indexed number of pages fetched since self::reset()
+        * @var int key 0-indexed number of pages fetched since self::reset()
         */
        private $key;
 
@@ -84,9 +87,9 @@ class BatchRowIterator implements RecursiveIterator {
 
        /**
         * @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 $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
+        * @param int $batchSize The number of rows to fetch per iteration
         * @throws InvalidArgumentException
         */
        public function __construct( IDatabase $db, $table, $primaryKey, $batchSize ) {
@@ -164,7 +167,7 @@ class BatchRowIterator implements RecursiveIterator {
        }
 
        /**
-        * @return integer 0-indexed count of the page number fetched
+        * @return int 0-indexed count of the page number fetched
         */
        public function key() {
                return $this->key;
@@ -230,7 +233,7 @@ class BatchRowIterator implements RecursiveIterator {
         * `=` conditions while the final key uses a `>` condition
         *
         * Example output:
-        *        [ '( 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