From: jerome Date: Tue, 13 Jan 2009 08:04:18 +0000 (+0000) Subject: web service MDL-12886 change comments X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=442deb2531cb1beb931752c23e1625763ba0673b;p=moodle.git web service MDL-12886 change comments --- diff --git a/user/wsapi.php b/user/wsapi.php index 8c91fdc177..f34fc1b7f8 100644 --- a/user/wsapi.php +++ b/user/wsapi.php @@ -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)),