From: Brad Jorsch <bjorsch@wikimedia.org>
Date: Thu, 30 Oct 2014 17:23:09 +0000 (-0400)
Subject: API: Add doc warning to ApiPageSet::populateFromQueryResult
X-Git-Tag: 1.31.0-rc.0~13440
X-Git-Url: http://git.cyclocoop.org/%24self?a=commitdiff_plain;h=25a6a8669037b617a25c36ca43d52b383538e3a2;p=lhc%2Fweb%2Fwiklou.git

API: Add doc warning to ApiPageSet::populateFromQueryResult

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
---

diff --git a/includes/api/ApiPageSet.php b/includes/api/ApiPageSet.php
index ab705b2de4..db5eb52f23 100644
--- a/includes/api/ApiPageSet.php
+++ b/includes/api/ApiPageSet.php
@@ -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
 	 */