ApiBase.php:

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

diff --git a/includes/api/ApiRollback.php b/includes/api/ApiRollback.php
index 2301e3a..72604b9 100644 (file)
--- a/includes/api/ApiRollback.php
+++ b/includes/api/ApiRollback.php
@@ -1,10 +1,10 @@
 <?php
-
-/*
- * Created on Jun 20, 2007
+/**
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ * Created on Jun 20, 2007
+ *
+ * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
  *
  * 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
@@ -18,8 +18,10 @@
  *
  * 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' ) ) {
@@ -77,8 +79,14 @@ class ApiRollback extends ApiBase {
 
        public function getAllowedParams() {
                return array(
-                       'title' => null,
-                       'user' => null,
+                       'title' => array(
+                               ApiBase::PARAM_TYPE => 'string',
+                               ApiBase::PARAM_REQUIRED => true
+                       ),
+                       'user' => array(
+                               ApiBase::PARAM_TYPE => 'string',
+                               ApiBase::PARAM_REQUIRED => true
+                       ),
                        'token' => null,
                        'summary' => null,
                        'markbot' => false,
@@ -98,8 +106,8 @@ class ApiRollback extends ApiBase {
                return array(
                        'title' => 'Title of the page you want to rollback.',
                        'user' => 'Name of the user whose edits are to be rolled back. If set incorrectly, you\'ll get a badtoken error.',
-                       'token' => 'A rollback token previously retrieved through prop=revisions',
-                       'summary' => 'Custom edit summary. If not set, default summary will be used.',
+                       'token' => "A rollback token previously retrieved through {$this->getModulePrefix()}prop=revisions",
+                       'summary' => 'Custom edit summary. If not set, default summary will be used',
                        'markbot' => 'Mark the reverted edits and the revert as bot edits',
                        'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
                );
@@ -108,14 +116,12 @@ class ApiRollback extends ApiBase {
        public function getDescription() {
                return array(
                        'Undo the last edit to the page. If the last user who edited the page made multiple edits in a row,',
-                       'they will all be rolled back.'
+                       'they will all be rolled back'
                );
        }
 
        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
-                       array( 'missingparam', 'title' ),
-                       array( 'missingparam', 'user' ),
                        array( 'invalidtitle', 'title' ),
                        array( 'notanarticle' ),
                        array( 'invaliduser', 'user' ),
@@ -133,10 +139,6 @@ class ApiRollback extends ApiBase {
 
                $params = $this->extractRequestParams();
 
-               if ( !isset( $params['user'] ) ) {
-                       $this->dieUsageMsg( array( 'missingparam', 'user' ) );
-               }
-               
                // We need to be able to revert IPs, but getCanonicalName rejects them
                $this->mUser = User::isIP( $params['user'] )
                        ? $params['user']
@@ -154,9 +156,6 @@ class ApiRollback extends ApiBase {
                }
 
                $params = $this->extractRequestParams();
-               if ( !isset( $params['title'] ) ) {
-                       $this->dieUsageMsg( array( 'missingparam', 'title' ) );
-               }
 
                $this->mTitleObj = Title::newFromText( $params['title'] );
 
@@ -166,7 +165,7 @@ class ApiRollback extends ApiBase {
                if ( !$this->mTitleObj->exists() ) {
                        $this->dieUsageMsg( array( 'notanarticle' ) );
                }
-               
+
                return $this->mTitleObj;
        }