Merge "make list of 'Languages that support variant conversion' dynamic"

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

diff --git a/includes/api/ApiPatrol.php b/includes/api/ApiPatrol.php
index 2f248af..cb5e081 100644 (file)
--- a/includes/api/ApiPatrol.php
+++ b/includes/api/ApiPatrol.php
@@ -1,10 +1,9 @@
 <?php
-
 /**
- * Created on Sep 2, 2008
- *
  * API for MediaWiki 1.14+
  *
+ * Created on Sep 2, 2008
+ *
  * Copyright © 2008 Soxred93 soxred93@gmail.com,
  *
  * This program is free software; you can redistribute it and/or modify
@@ -21,12 +20,10 @@
  * 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' ) ) {
-       require_once ( 'ApiBase.php' );
-}
-
 /**
  * Allows user to patrol pages
  * @ingroup API
@@ -43,15 +40,11 @@ class ApiPatrol extends ApiBase {
        public function execute() {
                $params = $this->extractRequestParams();
 
-               if ( !isset( $params['rcid'] ) ) {
-                       $this->dieUsageMsg( array( 'missingparam', 'rcid' ) );
-               }
-
                $rc = RecentChange::newFromID( $params['rcid'] );
                if ( !$rc instanceof RecentChange ) {
                        $this->dieUsageMsg( array( 'nosuchrcid', $params['rcid'] ) );
                }
-               $retval = RecentChange::markPatrolled( $params['rcid'] );
+               $retval = $rc->doMarkPatrolled( $this->getUser() );
 
                if ( $retval ) {
                        $this->dieUsageMsg( reset( $retval ) );
@@ -62,15 +55,23 @@ class ApiPatrol extends ApiBase {
                $this->getResult()->addValue( null, $this->getModuleName(), $result );
        }
 
+       public function mustBePosted() {
+               return true;
+       }
+
        public function isWriteMode() {
                return true;
        }
 
        public function getAllowedParams() {
                return array(
-                       'token' => null,
+                       'token' => array(
+                               ApiBase::PARAM_TYPE => 'string',
+                               ApiBase::PARAM_REQUIRED => true
+                       ),
                        'rcid' => array(
-                               ApiBase::PARAM_TYPE => 'integer'
+                               ApiBase::PARAM_TYPE => 'integer',
+                               ApiBase::PARAM_REQUIRED => true
                        ),
                );
        }
@@ -82,27 +83,44 @@ class ApiPatrol extends ApiBase {
                );
        }
 
+       public function getResultProperties() {
+               return array(
+                       '' => array(
+                               'rcid' => 'integer',
+                               'ns' => 'namespace',
+                               'title' => 'string'
+                       )
+               );
+       }
+
        public function getDescription() {
                return 'Patrol a page or revision';
        }
 
        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
-                       array( 'missingparam', 'rcid' ),
                        array( 'nosuchrcid', 'rcid' ),
                ) );
        }
 
+       public function needsToken() {
+               return true;
+       }
+
        public function getTokenSalt() {
-               return '';
+               return 'patrol';
        }
 
-       protected function getExamples() {
+       public function getExamples() {
                return array(
                        'api.php?action=patrol&token=123abc&rcid=230672766'
                );
        }
 
+       public function getHelpUrls() {
+               return 'https://www.mediawiki.org/wiki/API:Patrol';
+       }
+
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }