webservice MDL-23144 support VALUE_DEFAULT empty array for single and multiple structure

diff --git a/lang/en/webservice.php b/lang/en/webservice.php
index 642c006..ba2c7aa 100644 (file)
--- a/lang/en/webservice.php
+++ b/lang/en/webservice.php
@@ -73,7 +73,9 @@ $string['errorinvalidparamsdesc'] = 'Invalid external api description';
 $string['errorinvalidresponseapi'] = 'Invalid external api response';
 $string['errorinvalidresponsedesc'] = 'Invalid external api response description';
 $string['errormissingkey'] = 'Missing required key in single structure: {$a}';
+$string['errornotemptydefaultparamarray'] = 'The web service description parameter named \'{$a}\' is an single or multiple structure. The default can only be empty array. Check web service description.';
 $string['erroronlyarray'] = 'Only arrays accepted.';
+$string['erroroptionalparamarray'] = 'The web service description parameter named \'{$a}\' is an single or multiple structure. It can not be set as VALUE_OPTIONAL. Check web service description.';
 $string['errorscalartype'] = 'Scalar type expected, array or object received.';
 $string['errorunexpectedkey'] = 'Unexpected keys detected in parameter array.';
 $string['execute'] = 'Execute';

diff --git a/lib/externallib.php b/lib/externallib.php
index d4289dc..b4067a5 100644 (file)
--- a/lib/externallib.php
+++ b/lib/externallib.php
@@ -166,15 +166,13 @@ class external_api {
                     if ($subdesc->required == VALUE_REQUIRED) {
                         throw new invalid_parameter_exception(get_string('errormissingkey', 'webservice', $key));
                     }
-                    if ($subdesc instanceof external_value) {
-                            if ($subdesc->required == VALUE_DEFAULT) {
-                                try {
-                                    $result[$key] = self::validate_parameters($subdesc, $subdesc->default);
-                                } catch (invalid_parameter_exception $e) {
-                                    throw new webservice_parameter_exception('invalidextparam',$key);
-                                }
-                            }
+                    if ($subdesc->required == VALUE_DEFAULT) {
+                        try {
+                            $result[$key] = self::validate_parameters($subdesc, $subdesc->default);
+                        } catch (invalid_parameter_exception $e) {
+                            throw new webservice_parameter_exception('invalidextparam',$key);
                         }
+                    }
                 } else {
                     try {
                         $result[$key] = self::validate_parameters($subdesc, $params[$key]);
@@ -320,15 +318,19 @@ abstract class external_description {
     public $desc;
     /** @property bool $required element value required, null not allowed */
     public $required;
+    /** @property mixed $default default value */
+    public $default;
 
     /**
      * Contructor
      * @param string $desc
      * @param bool $required
+     * @param mixed $default
      */
-    public function __construct($desc, $required) {
+    public function __construct($desc, $required, $default) {
         $this->desc = $desc;
         $this->required = $required;
+        $this->default = $default;
     }
 }
 
@@ -338,8 +340,6 @@ abstract class external_description {
 class external_value extends external_description {
     /** @property mixed $type value type PARAM_XX */
     public $type;
-    /** @property mixed $default default value */
-    public $default;
     /** @property bool $allownull allow null values */
     public $allownull;
 
@@ -351,10 +351,10 @@ class external_value extends external_description {
      * @param mixed $default
      * @param bool $allownull
      */
-    public function __construct($type, $desc='', $required=VALUE_REQUIRED, $default=null, $allownull=NULL_ALLOWED) {
-        parent::__construct($desc, $required);
-        $this->type      = $type;
-        $this->default   = $default;
+    public function __construct($type, $desc='', $required=VALUE_REQUIRED,
+            $default=null, $allownull=NULL_ALLOWED) {
+        parent::__construct($desc, $required, $default);
+        $this->type      = $type;        
         $this->allownull = $allownull;
     }
 }
@@ -371,9 +371,11 @@ class external_single_structure extends external_description {
      * @param array $keys
      * @param string $desc
      * @param bool $required
+     * @param array $default
      */
-    public function __construct(array $keys, $desc='', $required=VALUE_REQUIRED) {
-        parent::__construct($desc, $required);
+    public function __construct(array $keys, $desc='',
+            $required=VALUE_REQUIRED, $default=null) {
+        parent::__construct($desc, $required, $default);
         $this->keys = $keys;
     }
 }
@@ -390,9 +392,11 @@ class external_multiple_structure extends external_description {
      * @param external_description $content
      * @param string $desc
      * @param bool $required
+     * @param array $default
      */
-    public function __construct(external_description $content, $desc='', $required=VALUE_REQUIRED) {
-        parent::__construct($desc, $required);
+    public function __construct(external_description $content, $desc='',
+            $required=VALUE_REQUIRED, $default=null) {
+        parent::__construct($desc, $required, $default);
         $this->content = $content;
     }
 }

diff --git a/webservice/lib.php b/webservice/lib.php
index 9197d2a..f7e1f3f 100644 (file)
--- a/webservice/lib.php
+++ b/webservice/lib.php
@@ -637,8 +637,17 @@ class '.$classname.' {
                     throw new moodle_exception('parametercannotbevalueoptional');
                 }
             } else { //for the moment we do not support default for other structure types
-                 if ($keydesc->required == VALUE_OPTIONAL or $keydesc->required == VALUE_DEFAULT) {
-                     throw new moodle_exception('paramdefaultarraynotsupported');
+                 if ($keydesc->required == VALUE_DEFAULT) {
+                     //accept empty array as default
+                     if (isset($keydesc->default) and is_array($keydesc->default)
+                             and empty($keydesc->default)) {
+                         $param .= '=array()';
+                     } else {
+                        throw new moodle_exception('errornotemptydefaultparamarray', 'webservice', '', $name);
+                     }
+                 }
+                 if ($keydesc->required == VALUE_OPTIONAL) {
+                     throw new moodle_exception('erroroptionalparamarray', 'webservice', '', $name);
                  }
             }
             $params[]      = $param;