Move ApiFormatYaml_spyc.php to spyc.php as per r71763

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

diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php
index 099d6f5..29881e7 100644 (file)
--- a/includes/api/ApiBase.php
+++ b/includes/api/ApiBase.php
@@ -1,10 +1,9 @@
 <?php
-
 /**
- * Created on Sep 5, 2006
- *
  * API for MediaWiki 1.8+
  *
+ * Created on Sep 5, 2006
+ *
  * Copyright © 2006, 2010 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
  * This program is free software; you can redistribute it and/or modify
@@ -21,6 +20,8 @@
  * 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
  */
 
 /**
@@ -307,7 +308,7 @@ abstract class ApiBase {
                                if ( $deprecated ) {
                                        $desc = "DEPRECATED! $desc";
                                }
-                               
+
                                $required = isset( $paramSettings[self::PARAM_REQUIRED] ) ?
                                        $paramSettings[self::PARAM_REQUIRED] : false;
                                if ( $required ) {
@@ -494,20 +495,12 @@ abstract class ApiBase {
 
                        if ( $params ) { // getFinalParams() can return false
                                foreach ( $params as $paramName => $paramSettings ) {
-                                       $results[$paramName] = $this->getParameterFromSettings( 
+                                       $results[$paramName] = $this->getParameterFromSettings(
                                                $paramName, $paramSettings, $parseLimit );
                                }
                        }
                        $this->mParamCache[$parseLimit] = $results;
                }
-               
-               $allparams = $this->getAllowedParams();
-               foreach( $this->mParamCache[$parseLimit] as $param => $val ) {
-                       if( !isset( $allparams[$param][ApiBase::PARAM_REQUIRED] ) ) {
-                               $this->dieUsageMsg( array( 'missingparam', $param ) );
-                       }
-               }
-               
                return $this->mParamCache[$parseLimit];
        }
 
@@ -557,6 +550,7 @@ abstract class ApiBase {
         * @returns mixed
         */
        protected function getWatchlistValue ( $watchlist, $titleObj, $userOption = null ) {
+               global $wgUser;
                switch ( $watchlist ) {
                        case 'watch':
                                return true;
@@ -565,7 +559,6 @@ abstract class ApiBase {
                                return false;
 
                        case 'preferences':
-                               global $wgUser;
                                # If the user is already watching, don't bother checking
                                if ( $titleObj->userIsWatching() ) {
                                        return null;
@@ -625,12 +618,14 @@ abstract class ApiBase {
                        $type = gettype( $paramSettings );
                        $dupes = false;
                        $deprecated = false;
+                       $required = false;
                } else {
                        $default = isset( $paramSettings[self::PARAM_DFLT] ) ? $paramSettings[self::PARAM_DFLT] : null;
                        $multi = isset( $paramSettings[self::PARAM_ISMULTI] ) ? $paramSettings[self::PARAM_ISMULTI] : false;
                        $type = isset( $paramSettings[self::PARAM_TYPE] ) ? $paramSettings[self::PARAM_TYPE] : null;
                        $dupes = isset( $paramSettings[self::PARAM_ALLOW_DUPLICATES] ) ? $paramSettings[self::PARAM_ALLOW_DUPLICATES] : false;
                        $deprecated = isset( $paramSettings[self::PARAM_DEPRECATED] ) ? $paramSettings[self::PARAM_DEPRECATED] : false;
+                       $required = isset( $paramSettings[self::PARAM_REQUIRED] ) ? $paramSettings[self::PARAM_REQUIRED] : false;
 
                        // When type is not given, and no choices, the type is the same as $default
                        if ( !isset( $type ) ) {
@@ -668,7 +663,11 @@ abstract class ApiBase {
                                switch ( $type ) {
                                        case 'NULL': // nothing to do
                                                break;
-                                       case 'string': // nothing to do
+                                       case 'string':
+                                               if ( $required && $value === '' ) {
+                                                       $this->dieUsageMsg( array( 'missingparam', $paramName ) );
+                                               }
+
                                                break;
                                        case 'integer': // Force everything using intval() and optionally validate limits
 
@@ -720,8 +719,8 @@ abstract class ApiBase {
                                                break;
                                        case 'user':
                                                if ( !is_array( $value ) ) {
-                            $value = array( $value );
-                        }
+                                                       $value = array( $value );
+                                               }
 
                                                foreach ( $value as $key => $val ) {
                                                        $title = Title::makeTitleSafe( NS_USER, $val );
@@ -732,9 +731,9 @@ abstract class ApiBase {
                                                }
 
                                                if ( !$multi ) {
-                            $value = $value[0];
-                        }
-                        break;
+                                                       $value = $value[0];
+                                               }
+                                               break;
                                        default:
                                                ApiBase::dieDebug( __METHOD__, "Param $encParamName's type is unknown - $type" );
                                }
@@ -749,6 +748,8 @@ abstract class ApiBase {
                        if ( $deprecated && $value !== false ) {
                                $this->setWarning( "The $encParamName parameter has been deprecated." );
                        }
+               } else if ( $required ) {
+                       $this->dieUsageMsg( array( 'missingparam', $paramName ) );
                }
 
                return $value;
@@ -1126,6 +1127,15 @@ abstract class ApiBase {
        public function getPossibleErrors() {
                $ret = array();
 
+               $params = $this->getFinalParams();
+               if ( $params ) {
+                       foreach ( $params as $paramName => $paramSettings ) {
+                               if ( isset( $paramSettings[ApiBase::PARAM_REQUIRED] ) ) {
+                                       $ret[] = array( 'missingparam', $paramName );
+                               }
+                       }
+               }
+
                if ( $this->mustBePosted() ) {
                        $ret[] = array( 'mustbeposted', $this->getModuleName() );
                }