mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-31 12:45:04 +01:00
Code Issues Projects Releases Wiki Activity

web service MDL-12886 add beta documentation generator

Browse Source
This commit is contained in:
jerome 2009-02-18 05:01:10 +00:00
parent 159840f02b
commit 63cea891b9
2 changed files with 187 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

187
webservice/documentation.php Normal file
View File

@ -0,0 +1,187 @@
<?php
/**
* Moodle - Modular Object-Oriented Dynamic Learning Environment
* http://moodle.com
*
* LICENSE
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details:
*
* http://www.gnu.org/copyleft/gpl.html
*
* @category Moodle
* @package webservice
* @copyright Copyright (c) 1999 onwards Martin Dougiamas http://dougiamas.com
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL License
*/
/**
* This file generate a SOAP documentation in HTML
* This documentation describe how to call Moodle SOAP Web Service
*/
require_once('../config.php');
$protocol = optional_param('protocol',"soap",PARAM_ALPHA);
generate_documentation($protocol);
generate_functionlist();
function generate_documentation($protocol) {
switch ($protocol) {
case "soap":
$documentation = <<<EOF
<H2>SOAP Manual</H2>
<b>1.</b> Call the method <b>tmp_get_token</b> on "<i>http://remotemoodle/webservice/soap/zend_soap_server.php?wsdl</i>"<br>
Function parameter is an array: in PHP it would be array('username' => "wsuser", 'password' => "wspassword")<br>
Return value is a token (integer)<br>
<br>
<b>2.</b> Then call a moodle web service method on "<i>http://remotemoodle/webservice/soap/zend_soap_server.php?token=the_received_token&classpath=the_moodle_path&wsdl</i>"<br>
Every method has only one parameter which is an array.<br>
<br>
For example in PHP for this specific function:<br>
Moodle path: user<br>
<b>tmp_delete_user</b>( string username, integer mnethostid, )<br>
You will call something like:<br>
your_client->tmp_delete_user(array('username' => "username_to_delete",'mnethostid' => 1))<br>
EOF;
break;
default:
break;
}
echo $documentation;
}
function generate_functionlist () {
global $CFG;
$documentation = <<<EOF
<H2>list of web services functions</H2>
EOF;
//retrieve all external file
$externalfiles = array();
$externalfunctions = array();
setListApiFiles($externalfiles, $CFG->dirroot);
foreach ($externalfiles as $file) {
require($file);
$classpath = substr($file,strlen($CFG->dirroot)+1); //remove the dir root + / from the file path
$classpath = substr($classpath,0,strlen($classpath) - 13); //remove /external.php from the classpath
$classpath = str_replace('/','_',$classpath); //convert all / into _
$classname = $classpath."_external";
$api = new $classname();
$documentation .= <<<EOF
<H3>Moodle path: {$classpath}</H3>
EOF;
foreach($api->get_descriptions() as $functionname => $description) {
$documentation .= <<<EOF
<b>{$functionname}</b>(
EOF;
foreach ($description['params'] as $param => $paramtype) {
$wsparamtype = converterMoodleParamIntoWsParam($paramtype);
$documentation .= <<<EOF
{$wsparamtype} {$param},
EOF;
}
$documentation .= <<<EOF
<i>
EOF;
foreach ($description['optionalparams'] as $param => $paramtype) {
$wsparamtype = converterMoodleParamIntoWsParam($paramtype);
$documentation .= <<<EOF
{$wsparamtype} {$param},
EOF;
}
$documentation .= <<<EOF
</i>
EOF;
$documentation .= <<<EOF
);<br>
EOF;
}
}
echo $documentation;
}
/**
* Convert a Moodle type (PARAM_ALPHA, PARAM_NUMBER,...) as a SOAP type (string, interger,...)
* @param integer $moodleparam
* @return string SOAP type
*/
function converterMoodleParamIntoWsParam($moodleparam) {
switch ($moodleparam) {
case PARAM_NUMBER:
return "integer";
break;
case PARAM_INT:
return "integer";
break;
case PARAM_BOOL:
return "boolean";
break;
case PARAM_ALPHANUM:
return "string";
break;
case PARAM_RAW:
return "string";
break;
default:
return "object";
break;
}
}
/**
* Retrieve all external.php from Moodle
* @param <type> $
* @param <type> $directorypath
* @return boolean true if n
*/
function setListApiFiles( &$files, $directorypath )
{
if(is_dir($directorypath)){ //check that we are browsing a folder not a file
if( $dh = opendir($directorypath))
{
while( false !== ($file = readdir($dh)))
{
if( $file == '.' || $file == '..') { // Skip '.' and '..'
continue;
}
$path = $directorypath . '/' . $file;
///browse the subfolder
if( is_dir($path) ) {
setListApiFiles($files, $path);
}
///retrieve api.php file
else if ($file == "external.php") {
$files[] = $path;
}
}
closedir($dh);
}
}
}
?>

1
webservice/soap/testclient/zend_soap_client.php
View File

@ -41,7 +41,6 @@ try {
} catch (moodle_exception $exception) {
echo $exception;
}
echo $CFG->wwwroot."/webservice/soap/zend_soap_server.php?token=".$token."&classpath=user&wsdl";
//2. test functions
$client = new Zend_Soap_Client($CFG->wwwroot."/webservice/soap/zend_soap_server.php?token=".$token."&classpath=user&wsdl");