1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
<?php
/**
* @version $Revision: 1.11 $
* @package liberty
* @subpackage plugins_data
*/
// +----------------------------------------------------------------------+
// | Copyright (c) 2004, bitweaver.org
// +----------------------------------------------------------------------+
// | All Rights Reserved. See copyright.txt for details and a complete list of authors.
// | Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See license.txt for details
// |
// | For comments, please use phpdocu.sourceforge.net documentation standards!!!
// | -> see http://phpdocu.sourceforge.net/
// +----------------------------------------------------------------------+
// | Author (TikiWiki): Luis Argerich <lrargerich@users.sourceforge.net>
// | Reworked for Bitweaver (& Undoubtedly Screwed-Up)
// | by: StarRider <starrrider@users.sourceforge.net>
// +----------------------------------------------------------------------+
// $Id: data.gauge.php,v 1.11 2007/06/09 18:09:39 squareing Exp $
/**
* definitions
*/
define( 'PLUGIN_GUID_DATAGAUGE', 'datagauge' );
global $gLibertySystem;
$pluginParams = array (
'tag' => 'GAUGE',
'auto_activate' => FALSE,
'requires_pair' => TRUE,
'load_function' => 'data_gauge',
'title' => 'Gauge',
'help_page' => 'DataPluginGauge',
'description' => tra("This plugin displays a graphical GAUGE."),
'help_function' => 'data_gauge_help',
'syntax' => "{GAUGE color= bgcolor= max= value= size= perc= height= }" . tra("Description") . "{GAUGE}",
'path' => LIBERTY_PKG_PATH.'plugins/data.gauge.php',
'security' => 'registered',
'plugin_type' => DATA_PLUGIN
);
$gLibertySystem->registerPlugin( PLUGIN_GUID_DATAGAUGE, $pluginParams );
$gLibertySystem->registerDataTag( $pluginParams['tag'], PLUGIN_GUID_DATAGAUGE );
// Help Function
function data_gauge_help() {
$help =
'<table class="data help">'
.'<tr>'
.'<th>' . tra( "Key" ) . '</th>'
.'<th>' . tra( "Type" ) . '</th>'
.'<th>' . tra( "Comments" ) . '</th>'
.'</tr>'
.'<tr class="odd">'
.'<td>color</td>'
.'<td>' . tra( "colorname or hex color") . '<br />' . tra("(optional)") . '</td>'
.'<td>' . tra( "Specifies the color of the of the Bar in the Gauge. Colornames or HTML colors can be used. To specify HTML color the <strong>#</strong> character <strong>MUST</strong> be included like this: ( <strong>#RRGGBB </strong> ). If not specified - the <strong>Current Text Color</strong> will be used. See Note below for Colornames & HTML Colors Sources.") . '</td>'
.'</tr>'
.'<tr class="even">'
.'<td>bgcolor</td>'
.'<td>' . tra( "colorname or hex color") . '<br />' . tra("(optional)") . '</td>'
.'<td>' . tra( "Specifies the color of the Gauges Background. Colornames or HTML colors can be used. To specify HTML color the <strong>#</strong> character <strong>MUST</strong> be included like this: ( <strong>#RRGGBB </strong> ). If not specified - the <strong>Current Background Color</strong> will be used. See Note below for Colornames & HTML Colors Sources.") . '</td>'
.'</tr>'
.'<tr class="odd">'
.'<td>max</td>'
.'<td>' . tra( "numeric") . '<br />' . tra("(optional)") . '</td>'
.'<td>' . tra( "The maximum possible value to be displayed. The Gauge was designed to be used with percentages - so the Default = ") . '<strong>100</strong></td>'
.'</tr>'
.'<tr class="even">'
.'<td>value</td>'
.'<td>' . tra( "numeric") . '<br />' . tra("(Required)") . '</td>'
.'<td>' . tra( "The current value that the Gauge will display. There is") . ' <strong>NO</strong> ' . tra("Default value.") . '</td>'
.'</tr>'
.'<tr class="odd">'
.'<td>size</td>'
.'<td>' . tra( "numeric") . '<br />' . tra("(optional)") . '</td>'
.'<td>' . tra( "The width of the Bar in pixels. The Default = ") . '<strong>150</strong></td>'
.'</tr>'
.'<tr class="even">'
.'<td>height</td>'
.'<td>' . tra( "numeric") . '<br />' . tra("(optional)") . '</td>'
.'<td>' . tra( "The height of the Bar in pixels. The Default = ") . '<strong>14</strong></td>'
.'</tr>'
.'<tr class="odd">'
.'<td>perc</td>'
.'<td>' . tra( "boolean") . '<br />' . tra("(optional)") . '</td>'
.'<td>' . tra( "Determines if the <strong>%</strong> character is displayed after the value. Passing any value in this parameter will make it <strong>TRUE</strong>. The Default = <strong>FALSE</strong> so the <strong>%</strong> character will not be displayed") . '</td>'
.'</tr>'
.'<tr class="even">'
.'<td>Description</td>'
.'<td>' . tra( "boolean") . '<br />' . tra("(optional)") . '</td>'
.'<td>' . tra("<strong>This is NOT a Parameter.</strong> Text can be place between the 2 code blocks ( in this case:") . ' <strong>{GAUGE}</strong> ' . tra(" ). If present the text will be displayed below the Gauge.") . '</td>'
.'</tr>'
.'</table>'
. tra("Example: ") . "{GAUGE color='red' bgcolor='blue' value='25' perc='True' }A Simple Gauge{GAUGE}" . '<br />'
. tra("<strong>Note:</strong> Browser Safe Colornames are available on the ")
. '<a href="http://www.bitweaver.org/wiki/index.php?page=Web-Safe+HTML+Colors" title="Launch BitWeaver.Org in New Window" onkeypress="popUpWin(this.href,\'standard\',800,800);" onclick="popUpWin(this.href,\'standard\',800,800);return false;">' . tra( "BitWeaver Web Site" ) . '</a>'
. tra(" Another useful site for obtaining HTML colors is ")
. '<a href="http://www.pagetutor.com/pagetutor/makapage/picker" title="Launch PageTutor.com in New Window" onkeypress="popUpWin(this.href,\'standard\',800,800);" onclick="popUpWin(this.href,\'standard\',800,800);return false;">' . tra( "The Color Picker II" ) . '</a>';
return $help;
}
// Load Function
function data_gauge($data, $params) {
extract ($params, EXTR_SKIP);
if (!isset($max)) {
$max = 100;
}
if (!isset($value)) {
return tra("<b>ERROR</b> - Missing parameter. The ") . "__Gauge__" . tra(" plugin requires a value in the parameter ") . "__value__.";
}
if (!isset($size)) {
$size = 150;
}
if (!isset($bgcolor)) {
$bgcolor = '#0000FF';
}
if (!isset($color)) {
$color = '#FF0000';
}
if (!isset($perc)) {
$perc = false;
}
if ($perc) {
$perc = number_format($value / $max * 100, 2);
$perc = ' ' . $perc . '%';
} else {
$perc = '';
}
$h_size = floor($value / $max * $size);
if (!isset($height)) {
$height = 14;
}
$html = "<table border='0' cellpadding='0' cellspacing='0'><tr><td><table border='0' height='$height' cellpadding='0' cellspacing='0' width='$size' style='background-color:$bgcolor;'><tr><td style='background-color:$color;' width='$h_size'> </td><td> </td></tr></table></td><td>$perc</td></tr>";
if (!empty($data)) {
$html .= "<tr><td colspan='2'><small>$data</small></td></tr>";
}
$html .= "</table>";
return $html;
}
?>
|
