More parameter documentation

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

diff --git a/includes/api/ApiQueryWatchlist.php b/includes/api/ApiQueryWatchlist.php
index e6896da..5367e6a 100644 (file)
--- a/includes/api/ApiQueryWatchlist.php
+++ b/includes/api/ApiQueryWatchlist.php
@@ -1,9 +1,8 @@
 <?php
-
 /**
- * Created on Sep 25, 2006
  *
- * API for MediaWiki 1.8+
+ *
+ * Created on Sep 25, 2006
  *
  * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
@@ -21,6 +20,8 @@
  * 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
  */
 
 if ( !defined( 'MEDIAWIKI' ) ) {
@@ -50,8 +51,12 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 
        private $fld_ids = false, $fld_title = false, $fld_patrol = false, $fld_flags = false,
                        $fld_timestamp = false, $fld_user = false, $fld_comment = false, $fld_parsedcomment = false, $fld_sizes = false,
-                       $fld_notificationtimestamp = false;
+                       $fld_notificationtimestamp = false, $fld_userid = false;
 
+       /**
+        * @param $resultPageSet ApiPageSet
+        * @return void
+        */
        private function run( $resultPageSet = null ) {
                $this->selectNamedDB( 'watchlist', DB_SLAVE, 'watchlist' );
 
@@ -66,6 +71,7 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                        $this->fld_title = isset( $prop['title'] );
                        $this->fld_flags = isset( $prop['flags'] );
                        $this->fld_user = isset( $prop['user'] );
+                       $this->fld_userid = isset( $prop['userid'] );
                        $this->fld_comment = isset( $prop['comment'] );
                        $this->fld_parsedcomment = isset ( $prop['parsedcomment'] );
                        $this->fld_timestamp = isset( $prop['timestamp'] );
@@ -95,7 +101,7 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                        $this->addFieldsIf( 'rc_new', $this->fld_flags );
                        $this->addFieldsIf( 'rc_minor', $this->fld_flags );
                        $this->addFieldsIf( 'rc_bot', $this->fld_flags );
-                       $this->addFieldsIf( 'rc_user', $this->fld_user );
+                       $this->addFieldsIf( 'rc_user', $this->fld_user || $this->fld_userid );
                        $this->addFieldsIf( 'rc_user_text', $this->fld_user );
                        $this->addFieldsIf( 'rc_comment', $this->fld_comment || $this->fld_parsedcomment );
                        $this->addFieldsIf( 'rc_patrolled', $this->fld_patrol );
@@ -142,6 +148,7 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
 
                        // Check permissions.
                        if ( isset( $show['patrolled'] ) || isset( $show['!patrolled'] ) ) {
+                               global $wgUser;
                                if ( !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol() ) {
                                        $this->dieUsage( 'You need the patrol right to request the patrolled flag', 'permissiondenied' );
                                }
@@ -226,8 +233,16 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                        ApiQueryBase::addTitleInfo( $vals, $title );
                }
 
-               if ( $this->fld_user ) {
-                       $vals['user'] = $row->rc_user_text;
+               if ( $this->fld_user || $this->fld_userid ) {
+
+                       if ( $this->fld_user ) {
+                               $vals['user'] = $row->rc_user_text;
+                       }
+
+                       if ( $this->fld_userid ) {
+                               $vals['user'] = $row->rc_user;
+                       }
+
                        if ( !$row->rc_user ) {
                                $vals['anon'] = '';
                        }
@@ -310,13 +325,14 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                                ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
                        ),
                        'prop' => array(
-                               APIBase::PARAM_ISMULTI => true,
-                               APIBase::PARAM_DFLT => 'ids|title|flags',
-                               APIBase::PARAM_TYPE => array(
+                               ApiBase::PARAM_ISMULTI => true,
+                               ApiBase::PARAM_DFLT => 'ids|title|flags',
+                               ApiBase::PARAM_TYPE => array(
                                        'ids',
                                        'title',
                                        'flags',
                                        'user',
+                                       'userid',
                                        'comment',
                                        'parsedcomment',
                                        'timestamp',
@@ -362,7 +378,8 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                                ' ids                    - Adds revision ids and page ids',
                                ' title                  - Adds title of the page',
                                ' flags                  - Adds flags for the edit',
-                               ' user                   - Adds user who made the edit',
+                               ' user                   - Adds the user who made the edit',
+                               ' userid                 - Adds user id of whom made the edit',
                                ' comment                - Adds comment of the edit',
                                ' parsedcomment          - Adds parsed comment of the edit',
                                ' timestamp              - Adds timestamp of the edit',
@@ -399,9 +416,9 @@ class ApiQueryWatchlist extends ApiQueryGeneratorBase {
                return array(
                        'api.php?action=query&list=watchlist',
                        'api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment',
-                       'api.php?action=query&list=watchlist&wlallrev&wlprop=ids|title|timestamp|user|comment',
+                       'api.php?action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment',
                        'api.php?action=query&generator=watchlist&prop=info',
-                       'api.php?action=query&generator=watchlist&gwlallrev&prop=revisions&rvprop=timestamp|user',
+                       'api.php?action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user',
                        'api.php?action=query&list=watchlist&wlowner=Bob_Smith&wltoken=d8d562e9725ea1512894cdab28e5ceebc7f20237'
                );
        }