moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-04 08:26:37 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

web service MDL-12886 add lang strings for web services

Browse source
This commit is contained in:
jerome 2009-02-26 04:22:26 +00:00
parent 57416b8016
commit 87171bd8ee
2 changed files with 38 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

33
lang/en_utf8/webservice.php Normal file
View file

@ -0,0 +1,33 @@
<?php // $Id$
$string['soapdocumentation'] = '<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: <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><br>
';
$string['xmlrpcdocumentation'] = '<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=the_moodle_path&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>
';
$string['functionlist'] = 'list of web service functions';
$string['moodlepath'] = 'Moodle path';
?>

43
webservice/documentation.php
View file

@ -40,41 +40,12 @@ generate_functionlist();
*/ */
function generate_documentation($protocol) { function generate_documentation($protocol) {
switch ($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: <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; case "soap":
$documentation = get_string('soapdocumentation','webservice');
break; break;
case "xmlrpc": case "xmlrpc":
$documentation = <<<EOF $documentation = get_string('xmlrpcdocumentation','webservice');
<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=the_moodle_path&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; break;
default: default:
break; break;
@ -89,9 +60,7 @@ EOF;
*/ */
function generate_functionlist () { function generate_functionlist () {
global $CFG; global $CFG;
$documentation = <<<EOF $documentation = "<H2>".get_string('functionlist','webservice')."</H2>";
<H2>list of web service functions</H2>
EOF;
//retrieve all external file //retrieve all external file
$externalfiles = array(); $externalfiles = array();
@ -106,9 +75,7 @@ EOF;
$classpath = str_replace('/','_',$classpath); //convert all / into _ $classpath = str_replace('/','_',$classpath); //convert all / into _
$classname = $classpath."_external"; $classname = $classpath."_external";
$api = new $classname(); $api = new $classname();
$documentation .= <<<EOF $documentation .= "<H3>".get_string('moodlepath','webservice').": ".$classpath."</H3>";
<H3>Moodle path: {$classpath}</H3>
EOF;
$description = webservice_lib::generate_webservice_description($file, $classname); $description = webservice_lib::generate_webservice_description($file, $classname);