Merge "maintenance: Script to rename titles for Unicode uppercasing changes"

[lhc/web/wiklou.git] / includes / api / ApiQueryBase.php

diff --git a/includes/api/ApiQueryBase.php b/includes/api/ApiQueryBase.php
index 122e02f..ec432d8 100644 (file)
--- a/includes/api/ApiQueryBase.php
+++ b/includes/api/ApiQueryBase.php
@@ -21,7 +21,7 @@
  */
 
 use Wikimedia\Rdbms\IDatabase;
-use Wikimedia\Rdbms\ResultWrapper;
+use Wikimedia\Rdbms\IResultWrapper;
 
 /**
  * This is a base class for all Query modules.
@@ -151,7 +151,8 @@ abstract class ApiQueryBase extends ApiBase {
 
        /**
         * Add a set of tables to the internal array
-        * @param string|string[] $tables Table name or array of table names
+        * @param string|array $tables Table name or array of table names
+        *  or nested arrays for joins using parentheses for grouping
         * @param string|null $alias Table alias, or null for no alias. Cannot be
         *  used with multiple tables
         */
@@ -251,7 +252,7 @@ abstract class ApiQueryBase extends ApiBase {
        }
 
        /**
-        * Equivalent to addWhere(array($field => $value))
+        * Equivalent to addWhere( [ $field => $value ] )
         * @param string $field Field name
         * @param string|string[] $value Value; ignored if null or empty array
         */
@@ -367,7 +368,7 @@ abstract class ApiQueryBase extends ApiBase {
         * @param array|null &$hookData If set, the ApiQueryBaseBeforeQuery and
         *  ApiQueryBaseAfterQuery hooks will be called, and the
         *  ApiQueryBaseProcessRow hook will be expected.
-        * @return ResultWrapper
+        * @return IResultWrapper
         */
        protected function select( $method, $extraQuery = [], array &$hookData = null ) {
                $tables = array_merge(
@@ -501,7 +502,7 @@ abstract class ApiQueryBase extends ApiBase {
        /**
         * Same as addPageSubItems(), but one element of $data at a time
         * @param int $pageId Page ID
-        * @param array $item Data array à la ApiResult
+        * @param mixed $item Data à la ApiResult
         * @param string|null $elemname XML element name. If null, getModuleName()
         *  is used
         * @return bool Whether the element fit in the result