74c97e3d7f4c46bde88d52f2ec769ef360ae3952
3 * API for MediaWiki 1.14+
5 * Created on Sep 2, 2008
7 * Copyright © 2008 Soxred93 soxred93@gmail.com,
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
28 * Allows user to patrol pages
31 class ApiPatrol
extends ApiBase
{
33 public function __construct( $main, $action ) {
34 parent
::__construct( $main, $action );
38 * Patrols the article or provides the reason the patrol failed.
40 public function execute() {
41 $params = $this->extractRequestParams();
43 $rc = RecentChange
::newFromID( $params['rcid'] );
44 if ( !$rc instanceof RecentChange
) {
45 $this->dieUsageMsg( array( 'nosuchrcid', $params['rcid'] ) );
47 $retval = $rc->doMarkPatrolled( $this->getUser() );
50 $this->dieUsageMsg( reset( $retval ) );
53 $result = array( 'rcid' => intval( $rc->getAttribute( 'rc_id' ) ) );
54 ApiQueryBase
::addTitleInfo( $result, $rc->getTitle() );
55 $this->getResult()->addValue( null, $this->getModuleName(), $result );
58 public function mustBePosted() {
62 public function isWriteMode() {
66 public function getAllowedParams() {
70 ApiBase
::PARAM_TYPE
=> 'integer',
71 ApiBase
::PARAM_REQUIRED
=> true
76 public function getParamDescription() {
78 'token' => 'Patrol token obtained from list=recentchanges',
79 'rcid' => 'Recentchanges ID to patrol',
83 public function getDescription() {
84 return 'Patrol a page or revision';
87 public function getPossibleErrors() {
88 return array_merge( parent
::getPossibleErrors(), array(
89 array( 'nosuchrcid', 'rcid' ),
93 public function needsToken() {
97 public function getTokenSalt() {
101 public function getExamples() {
103 'api.php?action=patrol&token=123abc&rcid=230672766'
107 public function getHelpUrls() {
108 return 'http://www.mediawiki.org/wiki/API:Patrol';
111 public function getVersion() {
112 return __CLASS__
. ': $Id$';