Added parser test about brackets and for bug 21261

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

diff --git a/includes/api/ApiUserrights.php b/includes/api/ApiUserrights.php
index 9686217..6b6bbf8 100644 (file)
--- a/includes/api/ApiUserrights.php
+++ b/includes/api/ApiUserrights.php
@@ -1,10 +1,11 @@
 <?php
 
 /**
+ *
+ *
  * Created on Mar 24, 2009
- * API for MediaWiki 1.8+
  *
- * Copyright © 2009 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ * Copyright © 2009 Roan Kattouw <Firstname>.<Lastname>@gmail.com
  *
  * 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,15 +19,12 @@
  *
  * 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' ) ) {
-       // Eclipse helper - will be ignored in production
-       require_once( "ApiBase.php" );
-}
-
 /**
  * @ingroup API
  */
@@ -41,7 +39,7 @@ class ApiUserrights extends ApiBase {
        public function execute() {
                $params = $this->extractRequestParams();
 
-               $user = $this->getUser();
+               $user = $this->getUrUser();
 
                $form = new UserrightsPage;
                $r['user'] = $user->getName();
@@ -50,20 +48,21 @@ class ApiUserrights extends ApiBase {
                                $user, (array)$params['add'],
                                (array)$params['remove'], $params['reason'] );
 
-               $this->getResult()->setIndexedTagName( $r['added'], 'group' );
-               $this->getResult()->setIndexedTagName( $r['removed'], 'group' );
-               $this->getResult()->addValue( null, $this->getModuleName(), $r );
+               $result = $this->getResult();
+               $result->setIndexedTagName( $r['added'], 'group' );
+               $result->setIndexedTagName( $r['removed'], 'group' );
+               $result->addValue( null, $this->getModuleName(), $r );
        }
-       
-       private function getUser() {
+
+       /**
+        * @return User
+        */
+       private function getUrUser() {
                if ( $this->mUser !== null ) {
                        return $this->mUser;
                }
 
                $params = $this->extractRequestParams();
-               if ( is_null( $params['user'] ) ) {
-                       $this->dieUsageMsg( array( 'missingparam', 'user' ) );
-               }
 
                $form = new UserrightsPage;
                $status = $form->fetchUser( $params['user'] );
@@ -88,7 +87,10 @@ class ApiUserrights extends ApiBase {
 
        public function getAllowedParams() {
                return array (
-                       'user' => null,
+                       'user' => array(
+                               ApiBase::PARAM_TYPE => 'string',
+                               ApiBase::PARAM_REQUIRED => true
+                       ),
                        'add' => array(
                                ApiBase::PARAM_TYPE => User::getAllGroups(),
                                ApiBase::PARAM_ISMULTI => true
@@ -115,27 +117,27 @@ class ApiUserrights extends ApiBase {
        }
 
        public function getDescription() {
-               return array(
-                       'Add/remove a user to/from groups',
-               );
+               return 'Add/remove a user to/from groups';
        }
 
-       public function getPossibleErrors() {
-               return array_merge( parent::getPossibleErrors(), array(
-                       array( 'missingparam', 'user' ),
-               ) );
+       public function needsToken() {
+               return true;
        }
 
        public function getTokenSalt() {
-               return $this->getUser()->getName();
+               return $this->getUrUser()->getName();
        }
 
-       protected function getExamples() {
+       public function getExamples() {
                return array(
                        'api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC'
                );
        }
 
+       public function getHelpUrls() {
+               return 'http://www.mediawiki.org/wiki/API:User_group_membership';
+       }
+
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }