Fix URL to send read receipts from read_body (#1637572),
[squirrelmail.git] / functions / html.php
index 59f69a25b044d09c20a9e523c7f2517a2ae60d03..d1850788a8d9418d8aa20f972d23da373bdd6cfd 100644 (file)
  * the right to left implementation by "functionize" some
  * html outputs.
  *
- * @copyright © 1999-2006 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 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,6 +279,7 @@ function html_tag( $tag,                // Tag to output
     return( $ret );
 }
 
+
 /**
  * handy function to set url vars
  *
@@ -109,7 +299,7 @@ function set_url_var($url, $var, $val=0, $link=true) {
                     '/.+(\\?'.$var.')=(.*)$/AU',     /* at front and only var */
                     '/.+(\\&'.$var.')=(.*)$/AU'      /* at the end */
                     );
-    preg_replace('/&/','&',$url);
+    $url = str_replace('&','&',$url);
 
     // FIXME: why switch is used instead of if () or one preg_match()
     switch (true) {
@@ -143,9 +333,6 @@ function set_url_var($url, $var, $val=0, $link=true) {
     if ($k) {
         if ($val) {
             $rpl = "$k=$val";
-            if ($link) {
-                $rpl = preg_replace('/&/','&',$rpl);
-            }
         } else {
             $rpl = '';
         }
@@ -155,6 +342,10 @@ function set_url_var($url, $var, $val=0, $link=true) {
         $pat = "/$k=$v/";
         $url = preg_replace($pat,$rpl,$url);
     }
+    if ($link) {
+        $url = str_replace('&','&',$url);
+    }
     return $url;
 }
-?>
\ No newline at end of file
+
+