feature:2847 Display additional info for API methods fields

git-svn-id: http://piwigo.org/svn/trunk@20750 68402e56-0260-453c-a942-63ccdbb3a9ee
Piwigo · Feb 13, 2013 · 98f08b3 · 98f08b3
1 parent 9687732
commit 98f08b3
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/include/ws_core.inc.php b/include/ws_core.inc.php
@@ -572,6 +572,10 @@ static function ws_getMethodDetails($params, &$service)
       {
         $param_data['defaultValue'] = $options['default'];
       }
+      if (isset($options['info']))
+      {
+        $param_data['info'] = $options['info'];
+      }
       $res['params'][] = $param_data;
     }
     return $res;

diff --git a/tools/ws.htm b/tools/ws.htm
@@ -4,7 +4,9 @@
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   <title>Piwigo web API (web-services) explorer</title>
 
+  <link rel="stylesheet" type="text/css" href="http://cdn.jsdelivr.net/tiptip/1.3/tipTip.css">
   <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
+  <script type="text/javascript" src="https://cdn.jsdelivr.net/tiptip/1.3/jquery.tipTip.minified.js"></script>
 
   <style type="text/css">
   /* BEGIN CSS RESET
@@ -92,6 +94,9 @@
   }
   a.button:hover {color:#E5FF00;}
 
+  .methodInfo {float:right;display:inline-block;width:16px;height:16px;font-size:12px;line-height:16px;background:#555;border-radius:8px;font-family:"Times New Roman",sans-serif;font-style:italic;font-weight:bold;text-align:center;color:#fff;}
+  .methodInfo:hover {border:none;text-shadow:none;background:#888;cursor:pointer;color:#fff;}
+
   #iframeWrapper {width:100%;height:300px;padding:3px 3px 20px 3px;background:#F9F9F9;border:1px solid #cdcdcd;overflow:hidden;position:relative;}
   iframe {width:100%;height:100%;background:#fff;}
   </style>
@@ -408,14 +413,15 @@ <h3>Result</h3>
       var isOptional = method.params[i].optional;
       var acceptArray = method.params[i].acceptArray;
       var defaultValue = method.params[i].defaultValue == null ? '' : method.params[i].defaultValue;
+      var info = method.params[i].info == null ? '' : '<a class="methodInfo" title="'+ method.params[i].info + '">i</a>';
 
       // if an array is direclty printed, the delimiter is a comma where we use a pipe
       if (typeof defaultValue == 'object') {
         defaultValue = defaultValue.join('|');
       }
 
       methodParams+= '<tr>'+
-        '<td>'+ method.params[i].name +'</td>'+
+        '<td>'+ method.params[i].name + info +'</td>'+
         '<td class="mini">'+ (isOptional ? '?':'*') + (acceptArray ? ' []':'') +'</td>'+
         '<td class="input"><input type="text" class="methodParameterValue" data-id="'+ i +'" value="'+ defaultValue +'"></td>'+
         '<td class="mini"><input type="checkbox" class="methodParameterSend" data-id="'+ i +'" '+ (isOptional ? '':'checked="checked"') +'></td>'+
@@ -435,6 +441,14 @@ <h3>Result</h3>
   $("input.methodParameterValue").change(function() {
     $("input.methodParameterSend[data-id='"+ $(this).data('id') +"']").attr('checked', 'checked');
   });
+
+  // tiptip
+  $(".methodInfo").tipTip({
+    activation:"click",
+    maxWidth:"300px",
+    defaultPosition:"right",
+    delay:0
+  });
 }
 
 // invoke method