Changeset 20750

Timestamp:

Feb 13, 2013, 8:26:34 PM (11 years ago)

Author:

mistic100

Message:

feature:2847 Display additional info for API methods fields

Location:

trunk

Files:

• include/ws_core.inc.php (modified) (1 diff)
• tools/ws.htm (modified) (5 diffs)

trunk/include/ws_core.inc.php

@@ -573 +573 @@
         $param_data['defaultValue'] = $options['default'];
       }
+      if (isset($options['info']))
+      {
+        $param_data['info'] = $options['info'];
+      }
       $res['params'][] = $param_data;
     }

trunk/tools/ws.htm

@@ -5 +5 @@
   <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">
@@ -92 +94 @@
   }
   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;}
@@ -409 +414 @@
       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
@@ -416 +422 @@
 
       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>'+
@@ -435 +441 @@
   $("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
   });
 }