MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / includes / TitleArray.php

diff --git a/includes/TitleArray.php b/includes/TitleArray.php
index f7a9e1dc64edfcff7eac07fdcac99cdd659f89e4..bf2344bbb7717f93089c3e6f47d8ae3050dc2154 100644 (file)
--- a/includes/TitleArray.php
+++ b/includes/TitleArray.php
@@ -1,24 +1,45 @@
 <?php
 /**
+ * Class to walk into a list of Title objects.
+ *
  * Note: this entire file is a byte-for-byte copy of UserArray.php with
- * s/User/Title/.  If anyone can figure out how to do this nicely with inheri-
- * tance or something, please do so.
+ * s/User/Title/.  If anyone can figure out how to do this nicely with
+ * inheritance or something, please do so.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
+use Wikimedia\Rdbms\ResultWrapper;
+
 /**
  * The TitleArray class only exists to provide the newFromResult method at pre-
  * sent.
  */
 abstract class TitleArray implements Iterator {
        /**
-        * @param $res result A MySQL result including at least page_namespace and
+        * @param ResultWrapper $res A SQL result including at least page_namespace and
         *   page_title -- also can have page_id, page_len, page_is_redirect,
         *   page_latest (if those will be used).  See Title::newFromRow.
-        * @return TitleArray
+        * @return TitleArrayFromResult
         */
        static function newFromResult( $res ) {
                $array = null;
-               if ( !wfRunHooks( 'TitleArrayFromResult', array( &$array, $res ) ) ) {
+               if ( !Hooks::run( 'TitleArrayFromResult', [ &$array, $res ] ) ) {
                        return null;
                }
                if ( $array === null ) {
@@ -27,55 +48,12 @@ abstract class TitleArray implements Iterator {
                return $array;
        }
 
+       /**
+        * @param ResultWrapper $res
+        * @return TitleArrayFromResult
+        */
        protected static function newFromResult_internal( $res ) {
                $array = new TitleArrayFromResult( $res );
                return $array;
        }
 }
-
-class TitleArrayFromResult extends TitleArray {
-       var $res;
-       var $key, $current;
-
-       function __construct( $res ) {
-               $this->res = $res;
-               $this->key = 0;
-               $this->setCurrent( $this->res->current() );
-       }
-
-       protected function setCurrent( $row ) {
-               if ( $row === false ) {
-                       $this->current = false;
-               } else {
-                       $this->current = Title::newFromRow( $row );
-               }
-       }
-
-       public function count() {
-               return $this->res->numRows();
-       }
-
-       function current() {
-               return $this->current;
-       }
-
-       function key() {
-               return $this->key;
-       }
-
-       function next() {
-               $row = $this->res->next();
-               $this->setCurrent( $row );
-               $this->key++;
-       }
-
-       function rewind() {
-               $this->res->rewind();
-               $this->key = 0;
-               $this->setCurrent( $this->res->current() );
-       }
-
-       function valid() {
-               return $this->current !== false;
-       }
-}