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
{
34 * Patrols the article or provides the reason the patrol failed.
36 public function execute() {
37 $params = $this->extractRequestParams();
38 $this->requireOnlyOneParameter( $params, 'rcid', 'revid' );
40 if ( isset( $params['rcid'] ) ) {
41 $rc = RecentChange
::newFromId( $params['rcid'] );
43 $this->dieUsageMsg( [ 'nosuchrcid', $params['rcid'] ] );
46 $rev = Revision
::newFromId( $params['revid'] );
48 $this->dieUsageMsg( [ 'nosuchrevid', $params['revid'] ] );
50 $rc = $rev->getRecentChange();
53 'The revision ' . $params['revid'] . " can't be patrolled as it's too old",
59 $user = $this->getUser();
60 $tags = $params['tags'];
62 // Check if user can add tags
63 if ( !is_null( $tags ) ) {
64 $ableToTag = ChangeTags
::canAddTagsAccompanyingChange( $tags, $user );
65 if ( !$ableToTag->isOK() ) {
66 $this->dieStatus( $ableToTag );
70 $retval = $rc->doMarkPatrolled( $user, false, $tags );
73 $this->dieUsageMsg( reset( $retval ) );
76 $result = [ 'rcid' => intval( $rc->getAttribute( 'rc_id' ) ) ];
77 ApiQueryBase
::addTitleInfo( $result, $rc->getTitle() );
78 $this->getResult()->addValue( null, $this->getModuleName(), $result );
81 public function mustBePosted() {
85 public function isWriteMode() {
89 public function getAllowedParams() {
92 ApiBase
::PARAM_TYPE
=> 'integer'
95 ApiBase
::PARAM_TYPE
=> 'integer'
98 ApiBase
::PARAM_TYPE
=> 'tags',
99 ApiBase
::PARAM_ISMULTI
=> true,
104 public function needsToken() {
108 protected function getExamplesMessages() {
110 'action=patrol&token=123ABC&rcid=230672766'
111 => 'apihelp-patrol-example-rcid',
112 'action=patrol&token=123ABC&revid=230672766'
113 => 'apihelp-patrol-example-revid',
117 public function getHelpUrls() {
118 return 'https://www.mediawiki.org/wiki/API:Patrol';