X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fhtml.php;h=2df57f2e7aa0e9550a2e1639a06e7070ae1e5d48;hp=4f4f3efa933c51f828a603af55e2f4a3283a5f49;hb=54156b1cfd60ef726191e2209fbd4306a980a03c;hpb=792f911ea95a6a36e794a119548e7f8896035cc8 diff --git a/functions/html.php b/functions/html.php index 4f4f3efa..2df57f2e 100644 --- a/functions/html.php +++ b/functions/html.php @@ -7,15 +7,237 @@ * the right to left implementation by "functionize" some * html outputs. * - * @copyright © 1999-2005 The SquirrelMail Project Team + * @copyright © 1999-2007 The SquirrelMail Project Team * @license http://opensource.org/licenses/gpl-license.php GNU Public License * @version $Id$ * @package squirrelmail * @since 1.3.0 */ + +/** + * Generates a hyperlink + * + * @param string $uri The target link location + * @param string $text The link text + * @param string $target The location where the link should + * be opened (OPTIONAL; default not used) + * @param string $onclick The onClick JavaScript handler (OPTIONAL; + * default not used) + * @param string $class The CSS class name (OPTIONAL; default + * not used) + * @param string $id The ID name (OPTIONAL; default not used) + * @param string $name The anchor name (OPTIONAL; default not used) + * @param array $aAttribs Any extra attributes: this must be an + * associative array, where keys will be + * added as the attribute name, and values + * (which are optional - should be null if + * none should be used) will be placed in + * double quotes (pending template implementation) + * as the attribute value (OPTIONAL; default empty). + * + * @return string The desired hyperlink tag. + * + * @since 1.5.2 + * + */ +function create_hyperlink($uri, $text, $target='', $onclick='', + $class='', $id='', $name='', $aAttribs=array()) { + + global $oTemplate; + + $oTemplate->assign('uri', $uri); + $oTemplate->assign('text', $text); + $oTemplate->assign('target', $target); + $oTemplate->assign('onclick', $onclick); + $oTemplate->assign('class', $class); + $oTemplate->assign('id', $id); + $oTemplate->assign('name', $name); + + $oTemplate->assign('aAttribs', $aAttribs); + + return $oTemplate->fetch('hyperlink.tpl'); + +} + + +/** + * Generates an image tag + * + * @param string $src The image source path + * @param string $alt Alternate link text (OPTIONAL; default + * not used) + * @param string $width The width the image should be shown in + * (OPTIONAL; default not used) + * @param string $height The height the image should be shown in + * (OPTIONAL; default not used) + * @param string $border The image's border attribute value + * (OPTIONAL; default not used) + * @param string $class The CSS class name (OPTIONAL; default + * not used) + * @param string $id The ID name (OPTIONAL; default not used) + * @param string $onclick The onClick JavaScript handler (OPTIONAL; + * default not used) + * @param string $title The image's title attribute value + * (OPTIONAL; default not used) + * @param string $align The image's alignment attribute value + * (OPTIONAL; default not used) + * @param string $hspace The image's hspace attribute value + * (OPTIONAL; default not used) + * @param string $vspace The image's vspace attribute value + * (OPTIONAL; default not used) + * @param string $text_alternative A text replacement for the entire + * image tag, to be used at the + * discretion of the template set, + * if for some reason the image tag + * cannot or should not be produced + * (OPTIONAL; default not used) + * @param array $aAttribs Any extra attributes: this must be an + * associative array, where keys will be + * added as the attribute name, and values + * (which are optional - should be null if + * none should be used) will be placed in + * double quotes (pending template implementation) + * as the attribute value (OPTIONAL; default empty). + * + * @return string The desired hyperlink tag. + * + * @since 1.5.2 + * + */ +function create_image($src, $alt='', $width='', $height='', + $border='', $class='', $id='', $onclick='', + $title='', $align='', $hspace='', $vspace='', + $text_alternative='', $aAttribs=array()) { + + global $oTemplate; + + $oTemplate->assign('src', $src); + $oTemplate->assign('alt', $alt); + $oTemplate->assign('width', $width); + $oTemplate->assign('height', $height); + $oTemplate->assign('border', $border); + $oTemplate->assign('class', $class); + $oTemplate->assign('id', $id); + $oTemplate->assign('onclick', $onclick); + $oTemplate->assign('title', $title); + $oTemplate->assign('align', $align); + $oTemplate->assign('hspace', $hspace); + $oTemplate->assign('vspace', $vspace); + $oTemplate->assign('text_alternative', $text_alternative); + + $oTemplate->assign('aAttribs', $aAttribs); + + return $oTemplate->fetch('image.tpl'); + +} + + +/** + * Generates a label tag + * + * @param string $value The contents that belong inside the label + * @param string $for The ID to which the label applies (OPTIONAL; + * default not used) + * @param array $aAttribs Any extra attributes: this must be an + * associative array, where keys will be + * added as the attribute name, and values + * (which are optional - should be null if + * none should be used) will be placed in + * double quotes (pending template implementation) + * as the attribute value (OPTIONAL; default empty). + * + * @return string The desired label tag. + * + * @since 1.5.2 + * + */ +function create_label($value, $for='', $aAttribs=array()) { + + global $oTemplate; + + $oTemplate->assign('text', $value); + $oTemplate->assign('for', $for); + + $oTemplate->assign('aAttribs', $aAttribs); + + return $oTemplate->fetch('label.tpl'); + +} + + +/** + * Generates a span tag + * + * @param string $value The contents that belong inside the span + * @param string $class The CSS class name (OPTIONAL; default + * not used) + * @param string $id The ID name (OPTIONAL; default not used) + * @param array $aAttribs Any extra attributes: this must be an + * associative array, where keys will be + * added as the attribute name, and values + * (which are optional - should be null if + * none should be used) will be placed in + * double quotes (pending template implementation) + * as the attribute value (OPTIONAL; default empty). + * + * @return string The desired span tag. + * + * @since 1.5.2 + * + */ +function create_span($value, $class='', $id='', $aAttribs=array()) { + + global $oTemplate; + + $oTemplate->assign('value', $value); + $oTemplate->assign('class', $class); + $oTemplate->assign('id', $id); + + $oTemplate->assign('aAttribs', $aAttribs); + + return $oTemplate->fetch('span.tpl'); + +} + + +/** + * Generates an opening body tag + * + * @param string $onload Body onload JavaScript handler code + * (OPTIONAL; default not used) + * @param string $class The CSS class name (OPTIONAL; default + * not used) + * @param array $aAttribs Any extra attributes: this must be an + * associative array, where keys will be + * added as the attribute name, and values + * (which are optional - should be null if + * none should be used) will be placed in + * double quotes (pending template implementation) + * as the attribute value (OPTIONAL; default empty). + * + * @return string The desired body tag. + * + * @since 1.5.2 + * + */ +function create_body($onload='', $class='', $aAttribs=array()) { + + global $oTemplate; + + $oTemplate->assign('onload', $onload); + $oTemplate->assign('class', $class); + + $oTemplate->assign('aAttribs', $aAttribs); + + return $oTemplate->fetch('body.tpl'); + +} + + /** * Generates html tags +//FIXME: This should not be used anywhere in the core, or we should convert this to use templates. We sould not be assuming HTML output. * * @param string $tag Tag to output * @param string $val Value between tags @@ -90,113 +312,63 @@ function html_tag( $tag, // Tag to output return( $ret ); } + /** - * handy function to set url vars + * This function is used to add, modify or delete GET variables in a URL. + * It is especially useful when $url = $PHP_SELF + * + * Set $val to NULL to remove $var from $url. + * To ensure compatibility with older versions, use $val='0' to set $var to 0. * - * especially useful when $url = $PHP_SELF * @param string $url url that must be modified - * @param string $var variable name + * @param string $var GET variable name * @param string $val variable value * @param boolean $link controls sanitizing of ampersand in urls (since 1.3.2) + * * @return string $url modified url + * * @since 1.3.0 + * */ -function set_url_var($url, $var, $val=0, $link=true) { - $k = ''; - $pat_a = array ( - '/.+(\\&'.$var.')=(.*)\\&/AU', /* in the middle */ - '/.+\\?('.$var.')=(.*\\&).+/AU', /* at front, more follow */ - '/.+(\\?'.$var.')=(.*)$/AU', /* at front and only var */ - '/.+(\\&'.$var.')=(.*)$/AU' /* at the end */ - ); - preg_replace('/&/','&',$url); - - // FIXME: why switch is used instead of if () or one preg_match() - switch (true) { - case (preg_match($pat_a[0],$url,$regs)): - $k = $regs[1]; - $v = $regs[2]; - break; - case (preg_match($pat_a[1],$url,$regs)): - $k = $regs[1]; - $v = $regs[2]; - break; - case (preg_match($pat_a[2],$url,$regs)): - $k = $regs[1]; - $v = $regs[2]; - break; - case (preg_match($pat_a[3],$url,$regs)): - $k = $regs[1]; - $v = $regs[2]; - break; - default: - if ($val) { - if (strpos($url,'?')) { - $url .= "&$var=$val"; - } else { - $url .= "?$var=$val"; - } - } - break; - } +function set_url_var($url, $var, $val=null, $link=true) { + $url = str_replace('&','&',$url); - if ($k) { - if ($val) { - $rpl = "$k=$val"; - if ($link) { - $rpl = preg_replace('/&/','&',$rpl); - } - } else { - $rpl = ''; - } - if( substr($v,-1)=='&' ) { - $rpl .= '&'; + if (strpos($url, '?') === false) { + $url .= '?'; + } + + list($uri, $params) = explode('?', $url, 2); + + $newpar = array(); + $params = explode('&', $params); + + foreach ($params as $p) { + if (trim($p)) { + $p = explode('=', $p); + $newpar[$p[0]] = (isset($p[1]) ? $p[1] : ''); } - $pat = "/$k=$v/"; - $url = preg_replace($pat,$rpl,$url); } - return $url; -} -/** - * Temporary test function to process template vars with formatting. - * I use it for viewing the message_header (view_header.php) with - * a sort of template. - * @param mixed $var - * @param mixed $format_ar - * @since 1.3.0 - * @todo if function is temporary, then why it is used. - * @deprecated - */ -function echo_template_var($var, $format_ar = array() ) { - $frm_last = count($format_ar) -1; - - if (isset($format_ar[0])) echo $format_ar[0]; - $i = 1; + if (is_null($val)) { + unset($newpar[$var]); + } else { + $newpar[$var] = $val; + } - switch (true) { - case (is_string($var)): - echo $var; - break; - case (is_array($var)): - $frm_a = array_slice($format_ar,1,$frm_last-1); - foreach ($var as $a_el) { - if (is_array($a_el)) { - echo_template_var($a_el,$frm_a); - } else { - echo $a_el; - if (isset($format_ar[$i])) { - echo $format_ar[$i]; - } - $i++; - } - } - break; - default: - break; + if (!count($newpar)) { + return $uri; } - if (isset($format_ar[$frm_last]) && $frm_last>$i ) { - echo $format_ar[$frm_last]; + + $url = $uri . '?'; + foreach ($newpar as $name => $value) { + $url .= "$name=$value&"; } + + $url = substr($url, 0, -1); + if ($link) { + $url = str_replace('&','&',$url); + } + + return $url; } -?> \ No newline at end of file +