web service MDL-12886 add xmlrpc documentation generator

diff --git a/webservice/documentation.php b/webservice/documentation.php
index 22d59576ef80261260db59e4c0038cc8e443b810..b819d691dfa8e1549e537d4e4ae279f505d559cb 100644 (file)
--- a/webservice/documentation.php
+++ b/webservice/documentation.php
@@ -45,11 +45,29 @@ function generate_documentation($protocol) {
         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>
+        Moodle path: <b>user</b><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;
+        case "xmlrpc":
+            $documentation = <<<EOF
+        <H2>XMLRPC Manual</H2>
+        <b>1.</b> Call the method <b>authentication.tmp_get_token</b> on "<i>http://remotemoodle/webservice/xmlrpc/zend_xmlrpc_server.php</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/xmlrpc/zend_xmlrpc_server.php?classpath=user&token=the_received_token</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: <b>user</b><br>
+        <b>tmp_delete_user</b>( string username, integer mnethostid,   )<br>
+        You will call something like:<br>
+        your_client->call('user.tmp_delete_user', array(array('username' => "username_to_delete",'mnethostid' => 1)))<br>
+
 EOF;
             break;
         default: