4 * Created on Sep 2, 2008
6 * API for MediaWiki 1.14+
8 * Copyright © 2008 Soxred93 soxred93@gmail.com,
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if ( !defined( 'MEDIAWIKI' ) ) {
27 require_once ( 'ApiBase.php' );
31 * Allows user to patrol pages
34 class ApiPatrol
extends ApiBase
{
36 public function __construct( $main, $action ) {
37 parent
::__construct( $main, $action );
41 * Patrols the article or provides the reason the patrol failed.
43 public function execute() {
44 $params = $this->extractRequestParams();
46 if ( !isset( $params['rcid'] ) ) {
47 $this->dieUsageMsg( array( 'missingparam', 'rcid' ) );
50 $rc = RecentChange
::newFromID( $params['rcid'] );
51 if ( !$rc instanceof RecentChange
) {
52 $this->dieUsageMsg( array( 'nosuchrcid', $params['rcid'] ) );
54 $retval = RecentChange
::markPatrolled( $params['rcid'] );
57 $this->dieUsageMsg( reset( $retval ) );
60 $result = array( 'rcid' => intval( $rc->getAttribute( 'rc_id' ) ) );
61 ApiQueryBase
::addTitleInfo( $result, $rc->getTitle() );
62 $this->getResult()->addValue( null, $this->getModuleName(), $result );
65 public function isWriteMode() {
69 public function getAllowedParams() {
73 ApiBase
::PARAM_TYPE
=> 'integer'
78 public function getParamDescription() {
80 'token' => 'Patrol token obtained from list=recentchanges',
81 'rcid' => 'Recentchanges ID to patrol',
85 public function getDescription() {
87 'Patrol a page or revision. '
91 public function getPossibleErrors() {
92 return array_merge( parent
::getPossibleErrors(), array(
93 array( 'missingparam', 'rcid' ),
94 array( 'nosuchrcid', 'rcid' ),
98 public function getTokenSalt() {
102 protected function getExamples() {
104 'api.php?action=patrol&token=123abc&rcid=230672766'
108 public function getVersion() {
109 return __CLASS__
. ': $Id$';