6 * The idea is to inlcude here some functions to make easier
7 * the right to left implementation by "functionize" some
10 * @copyright 1999-2014 The SquirrelMail Project Team
11 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
13 * @package squirrelmail
19 * Generates a hyperlink
21 * @param string $uri The target link location
22 * @param string $text The link text
23 * @param string $target The location where the link should
24 * be opened (OPTIONAL; default not used)
25 * @param string $onclick The onClick JavaScript handler (OPTIONAL;
27 * @param string $class The CSS class name (OPTIONAL; default
29 * @param string $id The ID name (OPTIONAL; default not used)
30 * @param string $name The anchor name (OPTIONAL; default not used)
31 * @param array $aAttribs Any extra attributes: this must be an
32 * associative array, where keys will be
33 * added as the attribute name, and values
34 * (which are optional - should be null if
35 * none should be used) will be placed in
36 * double quotes (pending template implementation)
37 * as the attribute value (OPTIONAL; default empty).
39 * @return string The desired hyperlink tag.
44 function create_hyperlink($uri, $text, $target='', $onclick='',
45 $class='', $id='', $name='', $aAttribs=array()) {
49 $oTemplate->assign('uri', $uri);
50 $oTemplate->assign('text', $text);
51 $oTemplate->assign('target', $target);
52 $oTemplate->assign('onclick', $onclick);
53 $oTemplate->assign('class', $class);
54 $oTemplate->assign('id', $id);
55 $oTemplate->assign('name', $name);
57 $oTemplate->assign('aAttribs', $aAttribs);
59 return $oTemplate->fetch('hyperlink.tpl');
65 * Generates an image tag
67 * @param string $src The image source path
68 * @param string $alt Alternate link text (OPTIONAL; default
70 * @param string $width The width the image should be shown in
71 * (OPTIONAL; default not used)
72 * @param string $height The height the image should be shown in
73 * (OPTIONAL; default not used)
74 * @param string $border The image's border attribute value
75 * (OPTIONAL; default not used)
76 * @param string $class The CSS class name (OPTIONAL; default
78 * @param string $id The ID name (OPTIONAL; default not used)
79 * @param string $onclick The onClick JavaScript handler (OPTIONAL;
81 * @param string $title The image's title attribute value
82 * (OPTIONAL; default not used)
83 * @param string $align The image's alignment attribute value
84 * (OPTIONAL; default not used)
85 * @param string $hspace The image's hspace attribute value
86 * (OPTIONAL; default not used)
87 * @param string $vspace The image's vspace attribute value
88 * (OPTIONAL; default not used)
89 * @param string $text_alternative A text replacement for the entire
90 * image tag, to be used at the
91 * discretion of the template set,
92 * if for some reason the image tag
93 * cannot or should not be produced
94 * (OPTIONAL; default not used)
95 * @param array $aAttribs Any extra attributes: this must be an
96 * associative array, where keys will be
97 * added as the attribute name, and values
98 * (which are optional - should be null if
99 * none should be used) will be placed in
100 * double quotes (pending template implementation)
101 * as the attribute value (OPTIONAL; default empty).
103 * @return string The desired hyperlink tag.
108 function create_image($src, $alt='', $width='', $height='',
109 $border='', $class='', $id='', $onclick='',
110 $title='', $align='', $hspace='', $vspace='',
111 $text_alternative='', $aAttribs=array()) {
115 $oTemplate->assign('src', $src);
116 $oTemplate->assign('alt', $alt);
117 $oTemplate->assign('width', $width);
118 $oTemplate->assign('height', $height);
119 $oTemplate->assign('border', $border);
120 $oTemplate->assign('class', $class);
121 $oTemplate->assign('id', $id);
122 $oTemplate->assign('onclick', $onclick);
123 $oTemplate->assign('title', $title);
124 $oTemplate->assign('align', $align);
125 $oTemplate->assign('hspace', $hspace);
126 $oTemplate->assign('vspace', $vspace);
127 $oTemplate->assign('text_alternative', $text_alternative);
129 $oTemplate->assign('aAttribs', $aAttribs);
131 return $oTemplate->fetch('image.tpl');
137 * Generates a label tag
139 * @param string $value The contents that belong inside the label
140 * @param string $for The ID to which the label applies (OPTIONAL;
142 * @param array $aAttribs Any extra attributes: this must be an
143 * associative array, where keys will be
144 * added as the attribute name, and values
145 * (which are optional - should be null if
146 * none should be used) will be placed in
147 * double quotes (pending template implementation)
148 * as the attribute value (OPTIONAL; default empty).
150 * @return string The desired label tag.
155 function create_label($value, $for='', $aAttribs=array()) {
159 $oTemplate->assign('text', $value);
160 $oTemplate->assign('for', $for);
162 $oTemplate->assign('aAttribs', $aAttribs);
164 return $oTemplate->fetch('label.tpl');
170 * Generates a span tag
172 * @param string $value The contents that belong inside the span
173 * @param string $class The CSS class name (OPTIONAL; default
175 * @param string $id The ID name (OPTIONAL; default not used)
176 * @param array $aAttribs Any extra attributes: this must be an
177 * associative array, where keys will be
178 * added as the attribute name, and values
179 * (which are optional - should be null if
180 * none should be used) will be placed in
181 * double quotes (pending template implementation)
182 * as the attribute value (OPTIONAL; default empty).
184 * @return string The desired span tag.
189 function create_span($value, $class='', $id='', $aAttribs=array()) {
193 $oTemplate->assign('value', $value);
194 $oTemplate->assign('class', $class);
195 $oTemplate->assign('id', $id);
197 $oTemplate->assign('aAttribs', $aAttribs);
199 return $oTemplate->fetch('span.tpl');
205 * Generates an opening body tag
207 * @param string $onload Body onload JavaScript handler code
208 * (OPTIONAL; default not used)
209 * @param string $class The CSS class name (OPTIONAL; default
211 * @param array $aAttribs Any extra attributes: this must be an
212 * associative array, where keys will be
213 * added as the attribute name, and values
214 * (which are optional - should be null if
215 * none should be used) will be placed in
216 * double quotes (pending template implementation)
217 * as the attribute value (OPTIONAL; default empty).
219 * @return string The desired body tag.
224 function create_body($onload='', $class='', $aAttribs=array()) {
228 $oTemplate->assign('onload', $onload);
229 $oTemplate->assign('class', $class);
231 $oTemplate->assign('aAttribs', $aAttribs);
233 return $oTemplate->fetch('body.tpl');
239 * Generates html tags
240 //FIXME: This should not be used anywhere in the core, or we should convert this to use templates. We should not be assuming HTML output.
242 * @param string $tag Tag to output
243 * @param string $val Value between tags
244 * @param string $align Alignment (left, center, etc)
245 * @param string $bgcolor Back color in hexadecimal
246 * @param string $xtra Extra options
247 * @return string HTML ready for output
250 function html_tag( $tag, // Tag to output
251 $val = '', // Value between tags
252 $align = '', // Alignment
253 $bgcolor = '', // Back color
254 $xtra = '' ) { // Extra options
256 GLOBAL $languages, $squirrelmail_language;
258 $align = strtolower( $align );
260 $tag = strtolower( $tag );
262 if ( isset( $languages[$squirrelmail_language]['DIR']) ) {
263 $dir = $languages[$squirrelmail_language]['DIR'];
268 if ( $dir == 'ltr' ) {
276 if ( $bgcolor <> '' ) {
277 $bgc = " bgcolor=\"$bgcolor\"";
285 $alg = " align=\"$rgt\"";
288 $alg = " align=\"$lft\"";
291 $alg = " align=\"$align\"";
297 if ( $dir <> 'ltr' ) {
298 $ret .= " dir=\"$dir\"";
307 $ret .= ">$val</$tag>\n";
317 * This function is used to add, modify or delete more than
318 * one GET variable at a time in a URL. This simply takes
319 * an array of variables (key/value pairs) and passes them
320 * one at a time to {@link set_url_var}.
322 * Note that the value for any one of the variables may be
323 * an array, and it will be handled properly.
325 * As with set_url_var, any of the variable values may be
326 * set to NULL to remove it from the URI.
328 * Also, to ensure compatibility with older versions, use
329 * $val='0' to set $var to 0.
331 * @param string $uri URI that must be modified
332 * @param array $values List of GET variable names and their values
333 * @param boolean $sanitize Controls sanitizing of ampersand in URIs
335 * @return string The modified URI
340 function set_uri_vars($uri, $values, $sanitize=TRUE) {
341 foreach ($values as $key => $value)
342 if (is_array($value)) {
344 foreach ($value as $val)
345 $uri = set_url_var($uri, $key . '[' . $i++
. ']', $val, $sanitize);
348 $uri = set_url_var($uri, $key, $value, $sanitize);
354 * This function is used to add, modify or delete GET variables in a URL.
355 * It is especially useful when $url = $PHP_SELF
357 * Set $val to NULL to remove $var from $url.
358 * To ensure compatibility with older versions, use $val='0' to set $var to 0.
360 * @param string $url url that must be modified
361 * @param string $var GET variable name
362 * @param string $val variable value (CANNOT be an array)
363 * @param boolean $link controls sanitizing of ampersand in urls (since 1.3.2)
364 * @param boolean $treat_as_array When TRUE, if $var is an array (it occurs one
365 * or more times with square brackets after it,
366 * e.g. "var[1]"), the whole array will be removed
367 * (when $val is NULL) or the given value will be
368 * added to the next array slot (@since 1.4.23/1.5.2)
370 * @return string $url modified url
375 function set_url_var($url, $var, $val=null, $link=true, $treat_as_array=false) {
376 $url = str_replace('&','&',$url);
378 if (strpos($url, '?') === false) {
382 list($uri, $params) = explode('?', $url, 2);
385 $params = explode('&', $params);
386 $array_names = array();
388 foreach ($params as $p) {
390 $p = explode('=', $p);
391 $newpar[$p[0]] = (isset($p[1]) ?
$p[1] : '');
392 if ($treat_as_array && preg_match('/(.*)\[(\d+)]$/', $p[0], $matches)) {
393 if (!isset($array_names[$matches[1]])) $array_names[$matches[1]] = array();
394 $array_names[$matches[1]][$matches[2]] = $p[1];
400 if ($treat_as_array && !empty($array_names[$var])) {
401 foreach ($array_names[$var] as $key => $ignore)
402 unset($newpar[$var . '[' . $key . ']']);
404 unset($newpar[$var]);
407 if ($treat_as_array && !empty($array_names[$var])) {
409 foreach ($array_names[$var] as $key => $ignore)
410 if ($key >= $max_key) $max_key = $key +
1;
411 $newpar[$var . '[' . $max_key . ']'] = $val;
413 $newpar[$var] = $val;
417 if (!count($newpar)) {
422 foreach ($newpar as $name => $value) {
423 $url .= "$name=$value&";
426 $url = substr($url, 0, -1);
428 $url = str_replace('&','&',$url);