API: Add doc warning to ApiPageSet::populateFromQueryResult
authorBrad Jorsch <bjorsch@wikimedia.org>
Thu, 30 Oct 2014 17:23:09 +0000 (13:23 -0400)
committerUmherirrender <umherirrender_de.wp@web.de>
Thu, 30 Oct 2014 18:46:51 +0000 (18:46 +0000)
The cause of bug 72764 was an extension misusing
ApiPageSet::populateFromQueryResult(). Add a warning in the docs for
that method about proper usage.

Bug: 72764
Change-Id: I5b0a069d796f7f41ab0b16048d7b3d6600207383

includes/api/ApiPageSet.php

index ab705b2..db5eb52 100644 (file)
@@ -669,6 +669,10 @@ class ApiPageSet extends ApiBase {
 
        /**
         * Populate this PageSet from a rowset returned from the database
+        *
+        * Note that the query result must include the columns returned by
+        * $this->getPageTableFields().
+        *
         * @param DatabaseBase $db
         * @param ResultWrapper $queryResult Query result object
         */