]> git.mjollnir.org Git - moodle.git/commitdiff
web service MDL-12886 change comments
authorjerome <jerome>
Tue, 13 Jan 2009 08:04:18 +0000 (08:04 +0000)
committerjerome <jerome>
Tue, 13 Jan 2009 08:04:18 +0000 (08:04 +0000)
user/wsapi.php

index 8c91fdc1770f0cbb950ee34b8969be73fa3a3202..f34fc1b7f8d6fb722e0f9a4252fad4cb86ec0637 100644 (file)
@@ -26,12 +26,12 @@ final class user_ws_api extends moodle_ws_api {
        ///Note: web services param names have not importance. However 'paramorder' must match the function params order.
        ///And all web services param names defined into 'wsparams' should be included into 'paramorder' (otherwise they will not be used)
        ///
-       ///How to define an object/array attribut web service parameter: 'any object/array name' + _ + 'attribut/key name'. 'attribut/key name' must match the real attribut name.
-       ///e.g: a function has a parameter that is an object with a attribut named 'username'. You will need to declare 'anyobjectname_username' into 'wsparams'.
+       ///How to define an object/array attribut web service parameter: 'any object/array name' + ':' + 'attribut/key name'. 'attribut/key name' must match the real attribut name.
+       ///e.g: a function has a parameter that is an object with a attribut named 'username'. You will need to declare 'anyobjectname:username' into 'wsparams'.
        ///     Then 'paramorder'=> array('anyobjectname' => array('username' => ...));
        ///
        ///TODO: manage object->object parameter
-          $this->descriptions['tmp_get_users']   = array( 'wsparams' => array('search'=> PARAM_RAW),
+          $this->descriptions['tmp_get_users']   = array( 'wsparams' => array('search'=> PARAM_ALPHA),
                                                       'return' => array('user', array('id' => PARAM_RAW, 'auth' => PARAM_RAW, 'confirmed' => PARAM_RAW, 'username' => PARAM_RAW, 'idnumber' => PARAM_RAW,
                                                                                     'firstname' => PARAM_RAW, 'lastname' => PARAM_RAW, 'email' => PARAM_RAW, 'emailstop' => PARAM_RAW,
                                                                                     'lang' => PARAM_RAW, 'theme' => PARAM_RAW, 'timezone' => PARAM_RAW, 'mailformat' => PARAM_RAW)),