archive/piwigo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feature:2847 Display additional info for API methods fields

Browse source 
git-svn-id: http://piwigo.org/svn/trunk@20750 68402e56-0260-453c-a942-63ccdbb3a9ee
This commit is contained in:
mistic100 2013-02-13 19:26:34 +00:00
parent 9687732271
commit 98f08b3ee3
2 changed files with 19 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
include/ws_core.inc.php
View file

@ -572,6 +572,10 @@ Request format: ".@$this->_requestFormat." Response format: ".@$this->_responseF
{ {
$param_data['defaultValue'] = $options['default']; $param_data['defaultValue'] = $options['default'];
} }
if (isset($options['info']))
{
$param_data['info'] = $options['info'];
}
$res['params'][] = $param_data; $res['params'][] = $param_data;
} }
return $res; return $res;

16
tools/ws.htm
View file

@ -4,7 +4,9 @@
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Piwigo web API (web-services) explorer</title> <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://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"> <style type="text/css">
/* BEGIN CSS RESET /* BEGIN CSS RESET
@ -92,6 +94,9 @@
} }
a.button:hover {color:#E5FF00;} 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;} #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;} iframe {width:100%;height:100%;background:#fff;}
</style> </style>
@ -408,6 +413,7 @@ function fillNewMethod(methodName) {
var isOptional = method.params[i].optional; var isOptional = method.params[i].optional;
var acceptArray = method.params[i].acceptArray; var acceptArray = method.params[i].acceptArray;
var defaultValue = method.params[i].defaultValue == null ? '' : method.params[i].defaultValue; 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 an array is direclty printed, the delimiter is a comma where we use a pipe
if (typeof defaultValue == 'object') { if (typeof defaultValue == 'object') {
@ -415,7 +421,7 @@ function fillNewMethod(methodName) {
} }
methodParams+= '<tr>'+ methodParams+= '<tr>'+
'<td>'+ method.params[i].name +'</td>'+ '<td>'+ method.params[i].name + info +'</td>'+
'<td class="mini">'+ (isOptional ? '?':'*') + (acceptArray ? ' []':'') +'</td>'+ '<td class="mini">'+ (isOptional ? '?':'*') + (acceptArray ? ' []':'') +'</td>'+
'<td class="input"><input type="text" class="methodParameterValue" data-id="'+ i +'" value="'+ defaultValue +'"></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>'+ '<td class="mini"><input type="checkbox" class="methodParameterSend" data-id="'+ i +'" '+ (isOptional ? '':'checked="checked"') +'></td>'+
@ -435,6 +441,14 @@ function fillNewMethod(methodName) {
$("input.methodParameterValue").change(function() { $("input.methodParameterValue").change(function() {
$("input.methodParameterSend[data-id='"+ $(this).data('id') +"']").attr('checked', 'checked'); $("input.methodParameterSend[data-id='"+ $(this).data('id') +"']").attr('checked', 'checked');
}); });
// tiptip
$(".methodInfo").tipTip({
activation:"click",
maxWidth:"300px",
defaultPosition:"right",
delay:0
});
} }
// invoke method // invoke method