mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-18 22:08:20 +01:00
Code Issues Projects Releases Wiki Activity

MDL-12886 improved external API

Browse Source
This commit is contained in:
skodak 2009-09-16 19:00:12 +00:00
parent 5b658d18ad
commit d4e133554a
3 changed files with 61 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
group/externallib.php
View File

@ -45,7 +45,7 @@ class moodle_group_external extends external_api {
global $CFG;
require_once("$CFG->dirroot/group/lib.php");
$params = self::validate_params(self::create_groups_parameters(), $params);
$params = self::validate_prameters(self::create_groups_parameters(), $params);
$groups = array();
@ -91,7 +91,7 @@ class moodle_group_external extends external_api {
public static function get_groups($params) {
$groups = array();
$params = self::validate_params(self::get_groups_parameters(), $params);
$params = self::validate_prameters(self::get_groups_parameters(), $params);
//TODO: we do need to search for groups in courses too,
// fetching by id is not enough!
@ -128,7 +128,7 @@ class moodle_group_external extends external_api {
global $CFG;
require_once("$CFG->dirroot/group/lib.php");
$params = self::validate_params(self::delete_groups_parameters(), $params);
$params = self::validate_prameters(self::delete_groups_parameters(), $params);
$groups = array();
@ -166,7 +166,7 @@ class moodle_group_external extends external_api {
public static function get_groupmembers($params) {
$groups = array();
$params = self::validate_params(self::get_groupmembers_parameters(), $params);
$params = self::validate_prameters(self::get_groupmembers_parameters(), $params);
foreach ($params['groupids'] as $groupid) {
// validate params
@ -202,7 +202,7 @@ class moodle_group_external extends external_api {
global $CFG;
require_once("$CFG->dirroot/group/lib.php");
$params = self::validate_params(self::add_groupmembers_parameters(), $params);
$params = self::validate_prameters(self::add_groupmembers_parameters(), $params);
foreach ($params['membership'] as $member) {
// validate params
@ -240,7 +240,7 @@ class moodle_group_external extends external_api {
global $CFG;
require_once("$CFG->dirroot/group/lib.php");
$params = self::validate_params(self::delete_groupmembers_parameters(), $params);
$params = self::validate_prameters(self::delete_groupmembers_parameters(), $params);
foreach ($params['members'] as $member) {
// validate params

2
lib/externallib.php
View File

@ -59,7 +59,7 @@ class external_api {
* @param ? $params the actual parameters
* @return ? params with added defaults for optional items, invalid_parameters_exception thrown if any problem found
*/
public static function validate_params($description, $params) {
public static function validate_prameters($description, $params) {
//TODO: we need to define the structure of param descriptions
return $params;

78
user/externallib.php
View File

@ -28,16 +28,19 @@ require_once("$CFG->libdir/externallib.php");
class moodle_user_external extends external_api {
public static function create_users_params() {
public static function create_users_parameters() {
//TODO: the format of the description is not decided yet
$userpreference = array();
$userpreference->name = array(PARAM_ALPHANUMEXT, 'The name of the preference to set');
$userpreference->value = array(PARAM_RAW, 'The value of the preference');
$usercustomfields = new object();
$usercustomfields->name = array(PARAM_ALPHANUMEXT, 'The name of the custom field (must exist)');
$usercustomfields->value = array(PARAM_RAW, 'The value of the custom field');
$usertocreate = new object();
$usertocreate = new object();
$usertocreate->username = array(PARAM_USERNAME, 'Username policy is defined in Moodle security config', REQUIRED);
$usertocreate->password = array(PARAM_RAW, 'Moodle passwords can consist of any character', REQUIRED);
$usertocreate->firstname = array(PARAM_NOTAGS, 'The first name(s) of the user', REQUIRED);
@ -56,25 +59,18 @@ class moodle_user_external extends external_api {
$usertocreate->country = array(PARAM_ALPHA, 'Home country code of the user, such as AU or CZ');
$usertocreate->preferences = array('multiple' => $userpreference);
$usertocreate->custom = array('multiple' => $usercustomfields);
$createusersparams = new object();
$createusersparams->users = array('multiple' => $usertocreate);
return $createusersparams;
}
public static function create_users_return() {
$createusersreturn = new object();
$createusersreturn->userids = array('multiple' => PARAM_NUMBER);
return $createusersreturn;
}
/*
/**
* Create one or more users
*
* @param $params An array of users to create. Each user is defined by $usertocreate above.
*
*
* @return $return An array of userids, one for each user that was created
*/
public static function create_users($params) {
@ -88,19 +84,19 @@ class moodle_user_external extends external_api {
// Do basic automatic PARAM checks on incoming data, using params description
// This checks to make sure that:
// 1) No extra data was sent
// 2) All required items were sent
// 2) All required items were sent
// 3) All data passes clean_param without changes (yes this is strict)
// If any problems are found then exceptions are thrown with helpful error messages
self::validate_params($params, self::create_users_params());
$params = self::validate_prameters(self::create_users_parameters(), $params);
// Perform further checks and build up a clean array of user data
// Nothing is actually performed until the whole dataset is checked
$users = array();
foreach ($params as $user) {
foreach ($params['users'] as $user) {
// Empty or no auth is assumed to be manual
if (empty($user['auth'])) {
if (empty($user['auth'])) {
$user['auth'] = 'manual';
}
@ -138,6 +134,8 @@ class moodle_user_external extends external_api {
}
$DB->update_record('user', $record);
//TODO: preferences and custom fields
$result[] = $record->id;
// TODO: Save all the preferences and custom fields here
@ -146,29 +144,61 @@ class moodle_user_external extends external_api {
return $result;
}
public static function create_users_returns() {
//TODO: the format of the description is not decided yet
$createusersreturn = new object();
$createusersreturn->userids = array('multiple' => PARAM_NUMBER);
return $createusersreturn;
}
public static function delete_users_parameters() {
//TODO
}
public static function delete_users($params) {
//TODO
}
public static function update_users($params) {
public static function delete_users_returns() {
//TODO
}
public static function update_users_parameters() {
//TODO
}
public static function update_users($params) {
//TODO
}
public static function update_users_returns() {
//TODO
}
public static function get_users_parameters() {
}
public static function get_users($params) {
$context = get_context_instance(CONTEXT_SYSTEM);
require_capability('moodle/user:viewdetails', $context);
self::validate_context($context);
$search = validate_param($params['search'], PARAM_RAW);
$params = self::validate_prameters(self::get_users_parameters(), $params);
//TODO: this search is probably useless for external systems because it is not exact
// 1/ we should specify multiple search parameters including the mnet host id
// 2/ custom profile fileds not inlcuded
// 2/ custom profile fileds not included
$result = array();
$users = get_users(true, $params['search'], false, null, 'firstname ASC','', '', '', 1000, 'id, mnethostid, auth, confirmed, username, idnumber, firstname, lastname, email, emailstop, lang, theme, timezone, mailformat, city, description, country');
foreach ($users as $user) {
$result[] = (array)$user;
}
}
public static function get_users_returns() {
return get_users(true, $search, false, null, 'firstname ASC','', '', '', 1000, 'id, mnethostid, auth, confirmed, username, idnumber, firstname, lastname, email, emailstop, lang, theme, timezone, mailformat, city, description, country');
}
}