From: jerome <jerome>
Date: Fri, 27 Feb 2009 01:01:34 +0000 (+0000)
Subject: web service MDL-12886 documentation: check if "Display debug messages" is set Off
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=6fcd56724c8e296b6a0b4137baef937c7f91952d;p=moodle.git

web service MDL-12886 documentation: check if "Display debug messages" is set Off
---

diff --git a/group/external.php b/group/external.php
index b1bf8f36ed..c7f324dd40 100644
--- a/group/external.php
+++ b/group/external.php
@@ -21,7 +21,7 @@ final class group_external {
 
     /**
      * Creates a group
-     * @param array $params
+     * @param array|struct $params
      * @subparam string $params->groupname
      * @subparam integer $params->courseid
      * @return integer groupid
@@ -44,9 +44,9 @@ final class group_external {
 
     /**
      * Get a group member
-     * @param array $params
+     * @param array|struct $params
      * @subparam integer $params->groupid
-     * @return array $return
+     * @return object $return
      * @subreturn integer $return->group->id
      * @subreturn integer $return->group->courseid
      * @subreturn string $return->group->name
@@ -70,7 +70,7 @@ final class group_external {
 
     /**
      *
-     * @param array $params
+     * @param array|struct $params
      * @subparam integer $params->groupid
      * @return boolean result
      */
@@ -88,7 +88,7 @@ final class group_external {
 
     /**
      *
-     * @param array $params
+     * @param array|struct $params
      * @subparam integer $params->groupid
      * @subparam integer $params->userid
      * @return boolean result
@@ -98,7 +98,7 @@ final class group_external {
 
     /**
      * Add a member to a group
-     * @param array $params
+     * @param array|struct $params
      * @subparam integer $params->groupid
      * @subparam integer $params->userid
      * @return boolean result
@@ -117,7 +117,7 @@ final class group_external {
 
     /**
      *
-     * @param array $params
+     * @param array|struct $params
      * @subparam integer $params->groupid
      * @subparam integer $params->userid
      * @return boolean result
diff --git a/lang/en_utf8/webservice.php b/lang/en_utf8/webservice.php
index 26533c5414..b8a38b8d1e 100644
--- a/lang/en_utf8/webservice.php
+++ b/lang/en_utf8/webservice.php
@@ -36,4 +36,5 @@ $string['protocolenable'] = '$a[0] protocol enable';
 $string['ok'] = 'OK';
 $string['fail'] = 'FAIL';
 $string['wsuserreminder'] = 'Reminder: the Moodle administrator of this site needs to give you moodle/site:usewebservices capability.';
+$string['debugdisplayon'] = '\"Display debug messages\" is set On. The XMLRPC server will not work. The other web service servers could also return some problems. <br/>Alert the Moodle administrator to set it Off.';
 ?>
diff --git a/user/external.php b/user/external.php
index bae11f6a36..10fc87526f 100644
--- a/user/external.php
+++ b/user/external.php
@@ -23,7 +23,7 @@ final class user_external {
      * @subparam string $params:searches->search2 optional - the string to search
      * @subparam string $params:searches->search3 - the string to search
      * @subparam string $params:airport->planes:plane->company->employees:employee->name - name of a employee of a company of a plane of an airport
-     * @return array $return
+     * @return object $return
      * @subreturn integer $return:user->id
      * @subreturn integer $return:user->auth
      * @subreturn integer $return:user->confirmed
@@ -59,7 +59,7 @@ final class user_external {
      * Retrieve all user
      * @param array|struct $params - need to be define as struct for XMLRPC
      * @subparam string $params->search - the string to search
-     * @return array $return
+     * @return object $return
      * @subreturn integer $return:user->id
      * @subreturn integer $return:user->auth
      * @subreturn integer $return:user->confirmed
diff --git a/webservice/documentation.php b/webservice/documentation.php
index 9152f0f242..d1bc8d095e 100644
--- a/webservice/documentation.php
+++ b/webservice/documentation.php
@@ -62,6 +62,11 @@ function check_webservices($protocol){
         }
     }
 
+    //check debugging
+    if ($CFG->debugdisplay) {
+        echo "<strong style=\"color:red\">".get_string('debugdisplayon','webservice')."</strong>";
+    }
+
 
 }