mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 14:27:22 +01:00
121 lines
3.8 KiB
PHP
121 lines
3.8 KiB
PHP
<?php
|
|
/**
|
|
*
|
|
* Rest library
|
|
*
|
|
* @author Jerome Mouneyrac, Ferran Recio, David Castro Garcia
|
|
*/
|
|
|
|
/**
|
|
*
|
|
* @author Jerome Mouneyrac
|
|
* @global object $CFG
|
|
* @param string $rest_arguments example: /mod/forum/get_discussion
|
|
* @return string xml object
|
|
*/
|
|
function call_moodle_function ($rest_arguments) {
|
|
global $CFG;
|
|
///REST params conversion
|
|
$functionname = substr($rest_arguments,strrpos($rest_arguments,"/")+1); //retrieve the function name (it's located after the last '/') in $rest_arguments
|
|
//$rest_argument
|
|
$apipath = substr($rest_arguments,0, strlen($rest_arguments) - strlen($functionname)); //api path is the other part of $rest_arguments
|
|
|
|
$classname = str_replace('/', '_', $apipath); // convert '/' into '_' (e.g. /mod/forum/ => _mod_forum_)
|
|
$classname = substr($classname,1, strlen($classname) - 1); //remove first _ (e.g. _mod_forum => mod_forum)
|
|
$coreclassname = $classname."api";
|
|
$classname .= 'ws_api';
|
|
|
|
///these three next lines can be generic => create a function
|
|
require_once($CFG->dirroot.$apipath.'wsapi.php');
|
|
$api = new $classname();
|
|
|
|
$description = $api->get_function_webservice_description($functionname); //retrieve the web service description for this function
|
|
|
|
///This following line is only REST protocol
|
|
$params = retrieve_params ($description); //retrieve the REST params
|
|
|
|
///Generic part to any protocols
|
|
if ($params === false) {
|
|
//return an error message, the REST params doesn't match with the web service description
|
|
}
|
|
require_once($CFG->dirroot.$apipath.'api.php');
|
|
$res = call_user_func_array ( $coreclassname.'::'.$functionname, $params);
|
|
|
|
///Transform result into xml in order to send the REST response
|
|
$return = mdl_conn_rest_object_to_xml ($res,$description['return'][0]);
|
|
|
|
return "<Result>$return</Result>";
|
|
}
|
|
|
|
|
|
/**
|
|
*
|
|
* @author Jerome Mouneyrac
|
|
* @param <type> $description
|
|
* @return <type>
|
|
*/
|
|
function retrieve_params ($description) {
|
|
$params = $description['paramorder'];
|
|
//retrieve REST param matching the description
|
|
|
|
foreach ($description['wsparams'] as $paramname => $paramtype) {
|
|
$value = optional_param($paramname,null,$paramtype);
|
|
if (!empty($value)) {
|
|
$fullstopposition = strrpos($paramname,":");
|
|
//case: param is an object/array
|
|
if (!empty($fullstopposition)) {
|
|
$params[substr($paramname,0,$fullstopposition)][substr($paramname,$fullstopposition+1, strlen($paramname) - $fullstopposition)] = $value;
|
|
} else {
|
|
$params[$paramname] = $value;
|
|
}
|
|
}
|
|
}
|
|
return $params;
|
|
}
|
|
|
|
/**
|
|
* auxiliar function for simplexml_object_to_xml
|
|
* @author Ferran Recio, David Castro Garcia
|
|
* @param $obj
|
|
* @param $tag
|
|
* @param $atts assoc array (key => value)
|
|
* @return string
|
|
*/
|
|
function mdl_conn_rest_object_to_xml ($obj, $tag,$atts=false) {
|
|
$res = '';
|
|
$tag_atts = '';
|
|
if ($atts) {
|
|
$main_atts = array();
|
|
foreach ($atts as $att=>$val) {
|
|
$main_atts[] = "$att=\"".urlencode($val)."\"";
|
|
}
|
|
if (count($main_atts)) $tag_atts = ' '.implode(' ',$main_atts);
|
|
}
|
|
|
|
//if is an object
|
|
if (is_object($obj)) {
|
|
$parts = get_object_vars($obj);
|
|
foreach ($parts as $tag2 => $val) {
|
|
$res.= mdl_conn_rest_object_to_xml ($val, $tag2);
|
|
}
|
|
return "<$tag$tag_atts>\n$res</$tag>\n";
|
|
}
|
|
//if it's an array all elements will be inside te same tag but with a new atribute key
|
|
if (is_array($obj)){
|
|
if (!$atts) $atts = array();
|
|
//we came from another array
|
|
if (isset($atts['keys'])) $atts = array();
|
|
foreach ($obj as $key=>$val) {
|
|
$array_atts = $atts;
|
|
$array_atts['key'] = $key;
|
|
$res.= mdl_conn_rest_object_to_xml ($val, $tag,$array_atts);
|
|
}
|
|
return $res;
|
|
}
|
|
//any other type, just encapsule it
|
|
$obj = htmlentities($obj);
|
|
return "<$tag$tag_atts>$obj</$tag>\n";
|
|
|
|
}
|
|
|
|
?>
|