Use IResultWrapper in code comments instead of ResultWrapper
authorAaron Schulz <aschulz@wikimedia.org>
Thu, 20 Jun 2019 19:03:34 +0000 (20:03 +0100)
committerAaron Schulz <aschulz@wikimedia.org>
Sat, 22 Jun 2019 17:58:39 +0000 (17:58 +0000)
Change-Id: Idb813c20bef0d41d0f9f01440daab4fee6cdb38d

includes/cache/LinkBatch.php
includes/export/WikiExporter.php
includes/specialpage/QueryPage.php

index 2573f8a..3edfe1b 100644 (file)
@@ -146,7 +146,7 @@ class LinkBatch {
        }
 
        /**
-        * Add a ResultWrapper containing IDs and titles to a LinkCache object.
+        * Add a result wrapper containing IDs and titles to a LinkCache object.
         * As normal, titles will go into the static Title cache field.
         * This function *also* stores extra fields of the title used for link
         * parsing to avoid extra DB queries.
@@ -187,7 +187,7 @@ class LinkBatch {
        }
 
        /**
-        * Perform the existence test query, return a ResultWrapper with page_id fields
+        * Perform the existence test query, return a result wrapper with page_id fields
         * @return bool|IResultWrapper
         */
        public function doQuery() {
index 8b42be1..fb1053c 100644 (file)
@@ -27,7 +27,7 @@
  * @defgroup Dump Dump
  */
 
-use Wikimedia\Rdbms\ResultWrapper;
+use Wikimedia\Rdbms\IResultWrapper;
 use Wikimedia\Rdbms\IDatabase;
 
 /**
@@ -468,7 +468,7 @@ class WikiExporter {
         * The result set should be sorted/grouped by page to avoid duplicate
         * page records in the output.
         *
-        * @param ResultWrapper $results
+        * @param IResultWrapper $results
         * @param object $lastRow the last row output from the previous call (or null if none)
         * @return object the last row processed
         */
@@ -517,7 +517,7 @@ class WikiExporter {
        }
 
        /**
-        * @param ResultWrapper $resultset
+        * @param IResultWrapper $resultset
         * @return int the log_id value of the last item output, or null if none
         */
        protected function outputLogStream( $resultset ) {
index 700672f..eb179bf 100644 (file)
@@ -660,7 +660,7 @@ abstract class QueryPage extends SpecialPage {
                # an OutputPage, and let them get on with it
                $this->outputResults( $out,
                        $this->getSkin(),
-                       $dbr, # Should use ResultWrapper for this
+                       $dbr, # Should use IResultWrapper for this
                        $res,
                        min( $this->numRows, $this->limit ), # do not format the one extra row, if exist
                        $this->offset );
@@ -738,13 +738,13 @@ abstract class QueryPage extends SpecialPage {
        }
 
        /**
-        * Creates a new LinkBatch object, adds all pages from the passed ResultWrapper (MUST include
+        * Creates a new LinkBatch object, adds all pages from the passed result wrapper (MUST include
         * title and optional the namespace field) and executes the batch. This operation will pre-cache
         * LinkCache information like page existence and information for stub color and redirect hints.
         *
-        * @param IResultWrapper $res The ResultWrapper object to process. Needs to include the title
+        * @param IResultWrapper $res The result wrapper to process. Needs to include the title
         *  field and namespace field, if the $ns parameter isn't set.
-        * @param null $ns Use this namespace for the given titles in the ResultWrapper object,
+        * @param null $ns Use this namespace for the given titles in the result wrapper,
         *  instead of the namespace value of $res.
         */
        protected function executeLBFromResultWrapper( IResultWrapper $res, $ns = null ) {