summaryrefslogtreecommitdiff
path: root/includes/api/ApiQueryRecentChanges.php
diff options
context:
space:
mode:
Diffstat (limited to 'includes/api/ApiQueryRecentChanges.php')
-rw-r--r--includes/api/ApiQueryRecentChanges.php382
1 files changed, 215 insertions, 167 deletions
diff --git a/includes/api/ApiQueryRecentChanges.php b/includes/api/ApiQueryRecentChanges.php
index 1f0de3be..fb0d42b8 100644
--- a/includes/api/ApiQueryRecentChanges.php
+++ b/includes/api/ApiQueryRecentChanges.php
@@ -1,11 +1,10 @@
<?php
-
-/*
- * Created on Oct 19, 2006
- *
+/**
* API for MediaWiki 1.8+
*
- * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Created on Oct 19, 2006
+ *
+ * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@@ -19,13 +18,15 @@
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
- require_once ( 'ApiQueryBase.php' );
+ require_once( 'ApiQueryBase.php' );
}
/**
@@ -37,12 +38,15 @@ if ( !defined( 'MEDIAWIKI' ) ) {
class ApiQueryRecentChanges extends ApiQueryBase {
public function __construct( $query, $moduleName ) {
- parent :: __construct( $query, $moduleName, 'rc' );
+ parent::__construct( $query, $moduleName, 'rc' );
}
- private $fld_comment = false, $fld_parsedcomment = false, $fld_user = false, $fld_flags = false,
- $fld_timestamp = false, $fld_title = false, $fld_ids = false,
- $fld_sizes = false;
+ private $fld_comment = false, $fld_parsedcomment = false, $fld_user = false, $fld_userid = false,
+ $fld_flags = false, $fld_timestamp = false, $fld_title = false, $fld_ids = false,
+ $fld_sizes = false, $fld_redirect = false, $fld_patrolled = false, $fld_loginfo = false, $fld_tags = false;
+
+ private $tokenFunctions;
+
/**
* Get an array mapping token names to their handler functions.
* The prototype for a token function is func($pageid, $title, $rc)
@@ -51,12 +55,14 @@ class ApiQueryRecentChanges extends ApiQueryBase {
*/
protected function getTokenFunctions() {
// Don't call the hooks twice
- if ( isset( $this->tokenFunctions ) )
+ if ( isset( $this->tokenFunctions ) ) {
return $this->tokenFunctions;
+ }
// If we're in JSON callback mode, no tokens can be obtained
- if ( !is_null( $this->getMain()->getRequest()->getVal( 'callback' ) ) )
+ if ( !is_null( $this->getMain()->getRequest()->getVal( 'callback' ) ) ) {
return array();
+ }
$this->tokenFunctions = array(
'patrol' => array( 'ApiQueryRecentChanges', 'getPatrolToken' )
@@ -64,36 +70,38 @@ class ApiQueryRecentChanges extends ApiQueryBase {
wfRunHooks( 'APIQueryRecentChangesTokens', array( &$this->tokenFunctions ) );
return $this->tokenFunctions;
}
-
- public static function getPatrolToken( $pageid, $title, $rc )
- {
+
+ public static function getPatrolToken( $pageid, $title, $rc ) {
global $wgUser;
if ( !$wgUser->useRCPatrol() && ( !$wgUser->useNPPatrol() ||
- $rc->getAttribute( 'rc_type' ) != RC_NEW ) )
+ $rc->getAttribute( 'rc_type' ) != RC_NEW ) )
+ {
return false;
-
+ }
+
// The patrol token is always the same, let's exploit that
static $cachedPatrolToken = null;
- if ( !is_null( $cachedPatrolToken ) )
- return $cachedPatrolToken;
-
- $cachedPatrolToken = $wgUser->editToken();
+ if ( is_null( $cachedPatrolToken ) ) {
+ $cachedPatrolToken = $wgUser->editToken( 'patrol' );
+ }
+
return $cachedPatrolToken;
}
/**
* Sets internal state to include the desired properties in the output.
- * @param $prop associative array of properties, only keys are used here
+ * @param $prop Array associative array of properties, only keys are used here
*/
public function initProperties( $prop ) {
- $this->fld_comment = isset ( $prop['comment'] );
- $this->fld_parsedcomment = isset ( $prop['parsedcomment'] );
- $this->fld_user = isset ( $prop['user'] );
- $this->fld_flags = isset ( $prop['flags'] );
- $this->fld_timestamp = isset ( $prop['timestamp'] );
- $this->fld_title = isset ( $prop['title'] );
- $this->fld_ids = isset ( $prop['ids'] );
- $this->fld_sizes = isset ( $prop['sizes'] );
+ $this->fld_comment = isset( $prop['comment'] );
+ $this->fld_parsedcomment = isset( $prop['parsedcomment'] );
+ $this->fld_user = isset( $prop['user'] );
+ $this->fld_userid = isset( $prop['userid'] );
+ $this->fld_flags = isset( $prop['flags'] );
+ $this->fld_timestamp = isset( $prop['timestamp'] );
+ $this->fld_title = isset( $prop['title'] );
+ $this->fld_ids = isset( $prop['ids'] );
+ $this->fld_sizes = isset( $prop['sizes'] );
$this->fld_redirect = isset( $prop['redirect'] );
$this->fld_patrolled = isset( $prop['patrolled'] );
$this->fld_loginfo = isset( $prop['loginfo'] );
@@ -104,6 +112,7 @@ class ApiQueryRecentChanges extends ApiQueryBase {
* Generates and outputs the result of this query based upon the provided parameters.
*/
public function execute() {
+ global $wgUser;
/* Get the parameters of the request. */
$params = $this->extractRequestParams();
@@ -112,73 +121,78 @@ class ApiQueryRecentChanges extends ApiQueryBase {
* AND rc_timestamp < $end AND rc_namespace = $namespace
* AND rc_deleted = '0'
*/
- $db = $this->getDB();
$this->addTables( 'recentchanges' );
$index = array( 'recentchanges' => 'rc_timestamp' ); // May change
$this->addWhereRange( 'rc_timestamp', $params['dir'], $params['start'], $params['end'] );
$this->addWhereFld( 'rc_namespace', $params['namespace'] );
$this->addWhereFld( 'rc_deleted', 0 );
- if ( !is_null( $params['type'] ) )
- $this->addWhereFld( 'rc_type', $this->parseRCType( $params['type'] ) );
+ if ( !is_null( $params['type'] ) ) {
+ $this->addWhereFld( 'rc_type', $this->parseRCType( $params['type'] ) );
+ }
if ( !is_null( $params['show'] ) ) {
$show = array_flip( $params['show'] );
/* Check for conflicting parameters. */
- if ( ( isset ( $show['minor'] ) && isset ( $show['!minor'] ) )
- || ( isset ( $show['bot'] ) && isset ( $show['!bot'] ) )
- || ( isset ( $show['anon'] ) && isset ( $show['!anon'] ) )
- || ( isset ( $show['redirect'] ) && isset ( $show['!redirect'] ) )
- || ( isset ( $show['patrolled'] ) && isset ( $show['!patrolled'] ) ) ) {
-
+ if ( ( isset( $show['minor'] ) && isset( $show['!minor'] ) )
+ || ( isset( $show['bot'] ) && isset( $show['!bot'] ) )
+ || ( isset( $show['anon'] ) && isset( $show['!anon'] ) )
+ || ( isset( $show['redirect'] ) && isset( $show['!redirect'] ) )
+ || ( isset( $show['patrolled'] ) && isset( $show['!patrolled'] ) )
+ )
+ {
$this->dieUsageMsg( array( 'show' ) );
}
-
+
// Check permissions
- global $wgUser;
- if ( ( isset( $show['patrolled'] ) || isset( $show['!patrolled'] ) ) && !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol() )
- $this->dieUsage( "You need the patrol right to request the patrolled flag", 'permissiondenied' );
+ if ( isset( $show['patrolled'] ) || isset( $show['!patrolled'] ) ) {
+ if ( !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol() ) {
+ $this->dieUsage( 'You need the patrol right to request the patrolled flag', 'permissiondenied' );
+ }
+ }
/* Add additional conditions to query depending upon parameters. */
- $this->addWhereIf( 'rc_minor = 0', isset ( $show['!minor'] ) );
- $this->addWhereIf( 'rc_minor != 0', isset ( $show['minor'] ) );
- $this->addWhereIf( 'rc_bot = 0', isset ( $show['!bot'] ) );
- $this->addWhereIf( 'rc_bot != 0', isset ( $show['bot'] ) );
- $this->addWhereIf( 'rc_user = 0', isset ( $show['anon'] ) );
- $this->addWhereIf( 'rc_user != 0', isset ( $show['!anon'] ) );
+ $this->addWhereIf( 'rc_minor = 0', isset( $show['!minor'] ) );
+ $this->addWhereIf( 'rc_minor != 0', isset( $show['minor'] ) );
+ $this->addWhereIf( 'rc_bot = 0', isset( $show['!bot'] ) );
+ $this->addWhereIf( 'rc_bot != 0', isset( $show['bot'] ) );
+ $this->addWhereIf( 'rc_user = 0', isset( $show['anon'] ) );
+ $this->addWhereIf( 'rc_user != 0', isset( $show['!anon'] ) );
$this->addWhereIf( 'rc_patrolled = 0', isset( $show['!patrolled'] ) );
$this->addWhereIf( 'rc_patrolled != 0', isset( $show['patrolled'] ) );
- $this->addWhereIf( 'page_is_redirect = 1', isset ( $show['redirect'] ) );
-
+ $this->addWhereIf( 'page_is_redirect = 1', isset( $show['redirect'] ) );
+
// Don't throw log entries out the window here
- $this->addWhereIf( 'page_is_redirect = 0 OR page_is_redirect IS NULL', isset ( $show['!redirect'] ) );
+ $this->addWhereIf( 'page_is_redirect = 0 OR page_is_redirect IS NULL', isset( $show['!redirect'] ) );
}
-
- if ( !is_null( $params['user'] ) && !is_null( $param['excludeuser'] ) )
+
+ if ( !is_null( $params['user'] ) && !is_null( $params['excludeuser'] ) ) {
$this->dieUsage( 'user and excludeuser cannot be used together', 'user-excludeuser' );
-
- if ( !is_null( $params['user'] ) )
- {
+ }
+
+ if ( !is_null( $params['user'] ) ) {
$this->addWhereFld( 'rc_user_text', $params['user'] );
$index['recentchanges'] = 'rc_user_text';
}
-
- if ( !is_null( $params['excludeuser'] ) )
+
+ if ( !is_null( $params['excludeuser'] ) ) {
// We don't use the rc_user_text index here because
// * it would require us to sort by rc_user_text before rc_timestamp
// * the != condition doesn't throw out too many rows anyway
$this->addWhere( 'rc_user_text != ' . $this->getDB()->addQuotes( $params['excludeuser'] ) );
+ }
/* Add the fields we're concerned with to our query. */
- $this->addFields( array (
+ $this->addFields( array(
'rc_timestamp',
'rc_namespace',
'rc_title',
'rc_cur_id',
'rc_type',
'rc_moved_to_ns',
- 'rc_moved_to_title'
+ 'rc_moved_to_title',
+ 'rc_deleted'
) );
/* Determine what properties we need to display. */
@@ -188,9 +202,9 @@ class ApiQueryRecentChanges extends ApiQueryBase {
/* Set up internal members based upon params. */
$this->initProperties( $prop );
- global $wgUser;
- if ( $this->fld_patrolled && !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol() )
- $this->dieUsage( "You need the patrol right to request the patrolled flag", 'permissiondenied' );
+ if ( $this->fld_patrolled && !$wgUser->useRCPatrol() && !$wgUser->useNPPatrol() ) {
+ $this->dieUsage( 'You need the patrol right to request the patrolled flag', 'permissiondenied' );
+ }
/* Add fields to our query if they are specified as a needed parameter. */
$this->addFieldsIf( 'rc_id', $this->fld_ids );
@@ -198,7 +212,7 @@ class ApiQueryRecentChanges extends ApiQueryBase {
$this->addFieldsIf( 'rc_last_oldid', $this->fld_ids );
$this->addFieldsIf( 'rc_comment', $this->fld_comment || $this->fld_parsedcomment );
$this->addFieldsIf( 'rc_user', $this->fld_user );
- $this->addFieldsIf( 'rc_user_text', $this->fld_user );
+ $this->addFieldsIf( 'rc_user_text', $this->fld_user || $this->fld_userid );
$this->addFieldsIf( 'rc_minor', $this->fld_flags );
$this->addFieldsIf( 'rc_bot', $this->fld_flags );
$this->addFieldsIf( 'rc_new', $this->fld_flags );
@@ -209,39 +223,37 @@ class ApiQueryRecentChanges extends ApiQueryBase {
$this->addFieldsIf( 'rc_log_type', $this->fld_loginfo );
$this->addFieldsIf( 'rc_log_action', $this->fld_loginfo );
$this->addFieldsIf( 'rc_params', $this->fld_loginfo );
- if ( $this->fld_redirect || isset( $show['redirect'] ) || isset( $show['!redirect'] ) )
- {
+ if ( $this->fld_redirect || isset( $show['redirect'] ) || isset( $show['!redirect'] ) ) {
$this->addTables( 'page' );
$this->addJoinConds( array( 'page' => array( 'LEFT JOIN', array( 'rc_namespace=page_namespace', 'rc_title=page_title' ) ) ) );
$this->addFields( 'page_is_redirect' );
}
}
-
+
if ( $this->fld_tags ) {
$this->addTables( 'tag_summary' );
$this->addJoinConds( array( 'tag_summary' => array( 'LEFT JOIN', array( 'rc_id=ts_rc_id' ) ) ) );
$this->addFields( 'ts_tags' );
}
-
+
if ( !is_null( $params['tag'] ) ) {
$this->addTables( 'change_tag' );
$this->addJoinConds( array( 'change_tag' => array( 'INNER JOIN', array( 'rc_id=ct_rc_id' ) ) ) );
$this->addWhereFld( 'ct_tag' , $params['tag'] );
global $wgOldChangeTagsIndex;
- $index['change_tag'] = $wgOldChangeTagsIndex ? 'ct_tag' : 'change_tag_tag_id';
+ $index['change_tag'] = $wgOldChangeTagsIndex ? 'ct_tag' : 'change_tag_tag_id';
}
-
+
$this->token = $params['token'];
$this->addOption( 'LIMIT', $params['limit'] + 1 );
$this->addOption( 'USE INDEX', $index );
$count = 0;
/* Perform the actual query. */
- $db = $this->getDB();
$res = $this->select( __METHOD__ );
/* Iterate through the rows, adding data extracted from them to our query result. */
- while ( $row = $db->fetchObject( $res ) ) {
+ foreach ( $res as $row ) {
if ( ++ $count > $params['limit'] ) {
// We've reached the one extra which shows that there are additional pages to be had. Stop here...
$this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->rc_timestamp ) );
@@ -252,18 +264,16 @@ class ApiQueryRecentChanges extends ApiQueryBase {
$vals = $this->extractRowInfo( $row );
/* Add that row's data to our final output. */
- if ( !$vals )
+ if ( !$vals ) {
continue;
+ }
$fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ), null, $vals );
- if ( !$fit )
- {
+ if ( !$fit ) {
$this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->rc_timestamp ) );
break;
}
}
- $db->freeResult( $res );
-
/* Format the result */
$this->getResult()->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'rc' );
}
@@ -279,15 +289,17 @@ class ApiQueryRecentChanges extends ApiQueryBase {
/* If page was moved somewhere, get the title of the move target. */
$movedToTitle = false;
if ( isset( $row->rc_moved_to_title ) && $row->rc_moved_to_title !== '' )
- $movedToTitle = Title :: makeTitle( $row->rc_moved_to_ns, $row->rc_moved_to_title );
+ {
+ $movedToTitle = Title::makeTitle( $row->rc_moved_to_ns, $row->rc_moved_to_title );
+ }
/* Determine the title of the page that has been changed. */
- $title = Title :: makeTitle( $row->rc_namespace, $row->rc_title );
+ $title = Title::makeTitle( $row->rc_namespace, $row->rc_title );
/* Our output data. */
- $vals = array ();
+ $vals = array();
- $type = intval ( $row->rc_type );
+ $type = intval( $row->rc_type );
/* Determine what kind of change this was. */
switch ( $type ) {
@@ -312,9 +324,10 @@ class ApiQueryRecentChanges extends ApiQueryBase {
/* Create a new entry in the result for the title. */
if ( $this->fld_title ) {
- ApiQueryBase :: addTitleInfo( $vals, $title );
- if ( $movedToTitle )
- ApiQueryBase :: addTitleInfo( $vals, $movedToTitle, "new_" );
+ ApiQueryBase::addTitleInfo( $vals, $title );
+ if ( $movedToTitle ) {
+ ApiQueryBase::addTitleInfo( $vals, $movedToTitle, 'new_' );
+ }
}
/* Add ids, such as rcid, pageid, revid, and oldid to the change's info. */
@@ -326,20 +339,32 @@ class ApiQueryRecentChanges extends ApiQueryBase {
}
/* Add user data and 'anon' flag, if use is anonymous. */
- if ( $this->fld_user ) {
- $vals['user'] = $row->rc_user_text;
- if ( !$row->rc_user )
+ if ( $this->fld_user || $this->fld_userid ) {
+
+ if ( $this->fld_user ) {
+ $vals['user'] = $row->rc_user_text;
+ }
+
+ if ( $this->fld_userid ) {
+ $vals['userid'] = $row->rc_user;
+ }
+
+ if ( !$row->rc_user ) {
$vals['anon'] = '';
+ }
}
/* Add flags, such as new, minor, bot. */
if ( $this->fld_flags ) {
- if ( $row->rc_bot )
+ if ( $row->rc_bot ) {
$vals['bot'] = '';
- if ( $row->rc_new )
+ }
+ if ( $row->rc_new ) {
$vals['new'] = '';
- if ( $row->rc_minor )
+ }
+ if ( $row->rc_minor ) {
$vals['minor'] = '';
+ }
}
/* Add sizes of each revision. (Only available on 1.10+) */
@@ -349,35 +374,42 @@ class ApiQueryRecentChanges extends ApiQueryBase {
}
/* Add the timestamp. */
- if ( $this->fld_timestamp )
+ if ( $this->fld_timestamp ) {
$vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->rc_timestamp );
+ }
/* Add edit summary / log summary. */
- if ( $this->fld_comment && isset( $row->rc_comment ) )
+ if ( $this->fld_comment && isset( $row->rc_comment ) ) {
$vals['comment'] = $row->rc_comment;
-
+ }
+
if ( $this->fld_parsedcomment && isset( $row->rc_comment ) ) {
global $wgUser;
$vals['parsedcomment'] = $wgUser->getSkin()->formatComment( $row->rc_comment, $title );
}
- if ( $this->fld_redirect )
- if ( $row->page_is_redirect )
+ if ( $this->fld_redirect ) {
+ if ( $row->page_is_redirect ) {
$vals['redirect'] = '';
+ }
+ }
/* Add the patrolled flag */
- if ( $this->fld_patrolled && $row->rc_patrolled == 1 )
+ if ( $this->fld_patrolled && $row->rc_patrolled == 1 ) {
$vals['patrolled'] = '';
-
+ }
+
if ( $this->fld_loginfo && $row->rc_type == RC_LOG ) {
$vals['logid'] = intval( $row->rc_logid );
$vals['logtype'] = $row->rc_log_type;
$vals['logaction'] = $row->rc_log_action;
- ApiQueryLogEvents::addLogParams( $this->getResult(),
+ ApiQueryLogEvents::addLogParams(
+ $this->getResult(),
$vals, $row->rc_params,
- $row->rc_log_type, $row->rc_timestamp );
+ $row->rc_log_type, $row->rc_timestamp
+ );
}
-
+
if ( $this->fld_tags ) {
if ( $row->ts_tags ) {
$tags = explode( ',', $row->ts_tags );
@@ -387,39 +419,39 @@ class ApiQueryRecentChanges extends ApiQueryBase {
$vals['tags'] = array();
}
}
-
- if ( !is_null( $this->token ) )
- {
+
+ if ( !is_null( $this->token ) ) {
$tokenFunctions = $this->getTokenFunctions();
- foreach ( $this->token as $t )
- {
+ foreach ( $this->token as $t ) {
$val = call_user_func( $tokenFunctions[$t], $row->rc_cur_id,
$title, RecentChange::newFromRow( $row ) );
- if ( $val === false )
+ if ( $val === false ) {
$this->setWarning( "Action '$t' is not allowed for the current user" );
- else
+ } else {
$vals[$t . 'token'] = $val;
+ }
}
}
return $vals;
}
- private function parseRCType( $type )
- {
- if ( is_array( $type ) )
- {
- $retval = array();
- foreach ( $type as $t )
- $retval[] = $this->parseRCType( $t );
- return $retval;
- }
- switch( $type )
- {
- case 'edit': return RC_EDIT;
- case 'new': return RC_NEW;
- case 'log': return RC_LOG;
+ private function parseRCType( $type ) {
+ if ( is_array( $type ) ) {
+ $retval = array();
+ foreach ( $type as $t ) {
+ $retval[] = $this->parseRCType( $t );
}
+ return $retval;
+ }
+ switch( $type ) {
+ case 'edit':
+ return RC_EDIT;
+ case 'new':
+ return RC_NEW;
+ case 'log':
+ return RC_LOG;
+ }
}
public function getCacheMode( $params ) {
@@ -441,36 +473,37 @@ class ApiQueryRecentChanges extends ApiQueryBase {
}
public function getAllowedParams() {
- return array (
- 'start' => array (
- ApiBase :: PARAM_TYPE => 'timestamp'
+ return array(
+ 'start' => array(
+ ApiBase::PARAM_TYPE => 'timestamp'
),
- 'end' => array (
- ApiBase :: PARAM_TYPE => 'timestamp'
+ 'end' => array(
+ ApiBase::PARAM_TYPE => 'timestamp'
),
- 'dir' => array (
- ApiBase :: PARAM_DFLT => 'older',
- ApiBase :: PARAM_TYPE => array (
+ 'dir' => array(
+ ApiBase::PARAM_DFLT => 'older',
+ ApiBase::PARAM_TYPE => array(
'newer',
'older'
)
),
- 'namespace' => array (
- ApiBase :: PARAM_ISMULTI => true,
- ApiBase :: PARAM_TYPE => 'namespace'
+ 'namespace' => array(
+ ApiBase::PARAM_ISMULTI => true,
+ ApiBase::PARAM_TYPE => 'namespace'
),
'user' => array(
- ApiBase :: PARAM_TYPE => 'user'
+ ApiBase::PARAM_TYPE => 'user'
),
'excludeuser' => array(
- ApiBase :: PARAM_TYPE => 'user'
+ ApiBase::PARAM_TYPE => 'user'
),
'tag' => null,
- 'prop' => array (
- ApiBase :: PARAM_ISMULTI => true,
- ApiBase :: PARAM_DFLT => 'title|timestamp|ids',
- ApiBase :: PARAM_TYPE => array (
+ 'prop' => array(
+ ApiBase::PARAM_ISMULTI => true,
+ ApiBase::PARAM_DFLT => 'title|timestamp|ids',
+ ApiBase::PARAM_TYPE => array(
'user',
+ 'userid',
'comment',
'parsedcomment',
'flags',
@@ -485,12 +518,12 @@ class ApiQueryRecentChanges extends ApiQueryBase {
)
),
'token' => array(
- ApiBase :: PARAM_TYPE => array_keys( $this->getTokenFunctions() ),
- ApiBase :: PARAM_ISMULTI => true
+ ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() ),
+ ApiBase::PARAM_ISMULTI => true
),
- 'show' => array (
- ApiBase :: PARAM_ISMULTI => true,
- ApiBase :: PARAM_TYPE => array (
+ 'show' => array(
+ ApiBase::PARAM_ISMULTI => true,
+ ApiBase::PARAM_TYPE => array(
'minor',
'!minor',
'bot',
@@ -503,16 +536,16 @@ class ApiQueryRecentChanges extends ApiQueryBase {
'!patrolled'
)
),
- 'limit' => array (
- ApiBase :: PARAM_DFLT => 10,
- ApiBase :: PARAM_TYPE => 'limit',
- ApiBase :: PARAM_MIN => 1,
- ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
- ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
+ 'limit' => array(
+ ApiBase::PARAM_DFLT => 10,
+ ApiBase::PARAM_TYPE => 'limit',
+ ApiBase::PARAM_MIN => 1,
+ ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
+ ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
),
- 'type' => array (
- ApiBase :: PARAM_ISMULTI => true,
- ApiBase :: PARAM_TYPE => array (
+ 'type' => array(
+ ApiBase::PARAM_ISMULTI => true,
+ ApiBase::PARAM_TYPE => array(
'edit',
'new',
'log'
@@ -522,29 +555,44 @@ class ApiQueryRecentChanges extends ApiQueryBase {
}
public function getParamDescription() {
- return array (
- 'start' => 'The timestamp to start enumerating from.',
- 'end' => 'The timestamp to end enumerating.',
- 'dir' => 'In which direction to enumerate.',
+ return array(
+ 'start' => 'The timestamp to start enumerating from',
+ 'end' => 'The timestamp to end enumerating',
+ 'dir' => 'In which direction to enumerate',
'namespace' => 'Filter log entries to only this namespace(s)',
'user' => 'Only list changes by this user',
'excludeuser' => 'Don\'t list changes by this user',
- 'prop' => 'Include additional pieces of information',
+ 'prop' => array(
+ 'Include additional pieces of information',
+ ' user - Adds the user responsible for the edit and tags if they are an IP',
+ ' userid - Adds the user id responsible for the edit',
+ ' comment - Adds the comment for the edit',
+ ' parsedcomment - Adds the parsed comment for the edit',
+ ' flags - Adds flags for the edit',
+ ' timestamp - Adds timestamp of the edit',
+ ' title - Adds the page title of the edit',
+ ' ids - Adds the page id, recent changes id and the new and old revision id',
+ ' sizes - Adds the new and old page length in bytes',
+ ' redirect - Tags edit if page is a redirect',
+ ' patrolled - Tags edits have have been patrolled',
+ ' loginfo - Adds log information (logid, logtype, etc) to log entries',
+ ' tags - Lists tags for the entry',
+ ),
'token' => 'Which tokens to obtain for each change',
- 'show' => array (
+ 'show' => array(
'Show only items that meet this criteria.',
- 'For example, to see only minor edits done by logged-in users, set show=minor|!anon'
+ "For example, to see only minor edits done by logged-in users, set {$this->getModulePrefix()}show=minor|!anon"
),
- 'type' => 'Which types of changes to show.',
- 'limit' => 'How many total changes to return.',
- 'tag' => 'Only list changes tagged with this tag.',
+ 'type' => 'Which types of changes to show',
+ 'limit' => 'How many total changes to return',
+ 'tag' => 'Only list changes tagged with this tag',
);
}
public function getDescription() {
return 'Enumerate recent changes';
}
-
+
public function getPossibleErrors() {
return array_merge( parent::getPossibleErrors(), array(
array( 'show' ),
@@ -554,12 +602,12 @@ class ApiQueryRecentChanges extends ApiQueryBase {
}
protected function getExamples() {
- return array (
+ return array(
'api.php?action=query&list=recentchanges'
);
}
public function getVersion() {
- return __CLASS__ . ': $Id: ApiQueryRecentChanges.php 69932 2010-07-26 08:03:21Z tstarling $';
+ return __CLASS__ . ': $Id: ApiQueryRecentChanges.php 78437 2010-12-15 14:14:16Z catrope $';
}
}