document html functions

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@10425 7612ce4b-ef26-0410-bec9-ea0150e637f0

diff --git a/functions/html.php b/functions/html.php
index 62733c4d814f8bbb88c6f1231407f51822f8dc0f..4f4f3efa933c51f828a603af55e2f4a3283a5f49 100644 (file)
--- a/functions/html.php
+++ b/functions/html.php
@@ -11,10 +11,11 @@
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
+ * @since 1.3.0
  */
 
 /**
- * Generate html tags
+ * Generates html tags
  *
  * @param string $tag Tag to output
  * @param string $val Value between tags
@@ -22,6 +23,7 @@
  * @param string $bgcolor Back color in hexadecimal
  * @param string $xtra Extra options
  * @return string HTML ready for output
+ * @since 1.3.0
  */
 function html_tag( $tag,                // Tag to output
                        $val = '',           // Value between tags
@@ -29,155 +31,172 @@ function html_tag( $tag,                // Tag to output
                        $bgcolor = '',       // Back color
                        $xtra = '' ) {       // Extra options
 
-        GLOBAL $languages, $squirrelmail_language;
+    GLOBAL $languages, $squirrelmail_language;
 
-        $align = strtolower( $align );
-        $bgc = '';
-        $tag = strtolower( $tag );
+    $align = strtolower( $align );
+    $bgc = '';
+    $tag = strtolower( $tag );
 
-        if ( isset( $languages[$squirrelmail_language]['DIR']) ) {
-            $dir = $languages[$squirrelmail_language]['DIR'];
-        } else {
-            $dir = 'ltr';
-        }
-
-        if ( $dir == 'ltr' ) {
-            $rgt = 'right';
-            $lft = 'left';
-        } else {
-            $rgt = 'left';
-            $lft = 'right';
-        }
+    if ( isset( $languages[$squirrelmail_language]['DIR']) ) {
+        $dir = $languages[$squirrelmail_language]['DIR'];
+    } else {
+        $dir = 'ltr';
+    }
 
-        if ( $bgcolor <> '' ) {
-            $bgc = " bgcolor=\"$bgcolor\"";
-        }
+    if ( $dir == 'ltr' ) {
+        $rgt = 'right';
+        $lft = 'left';
+    } else {
+        $rgt = 'left';
+        $lft = 'right';
+    }
 
-        switch ( $align ) {
-            case '':
-                $alg = '';
-                break;
-            case 'right':
-                $alg = " align=\"$rgt\"";
-                break;
-            case 'left':
-                $alg = " align=\"$lft\"";
-                break;
-            default:
-                $alg = " align=\"$align\"";
-                break;
-        }
+    if ( $bgcolor <> '' ) {
+        $bgc = " bgcolor=\"$bgcolor\"";
+    }
 
-        $ret = "<$tag";
+    switch ( $align ) {
+    case '':
+        $alg = '';
+        break;
+    case 'right':
+        $alg = " align=\"$rgt\"";
+        break;
+    case 'left':
+        $alg = " align=\"$lft\"";
+        break;
+    default:
+        $alg = " align=\"$align\"";
+        break;
+    }
 
-        if ( $dir <> 'ltr' ) {
-            $ret .= " dir=\"$dir\"";
-        }
-        $ret .= $bgc . $alg;
+    $ret = "<$tag";
 
-        if ( $xtra <> '' ) {
-            $ret .= " $xtra";
-        }
+    if ( $dir <> 'ltr' ) {
+        $ret .= " dir=\"$dir\"";
+    }
+    $ret .= $bgc . $alg;
 
-        if ( $val <> '' ) {
-            $ret .= ">$val</$tag>\n";
-        } else {
-            $ret .= '>'. "\n";
-        }
+    if ( $xtra <> '' ) {
+        $ret .= " $xtra";
+    }
 
-        return( $ret );
+    if ( $val <> '' ) {
+        $ret .= ">$val</$tag>\n";
+    } else {
+        $ret .= '>'. "\n";
     }
 
-    /* handy function to set url vars */
-    /* especially usefull when $url = $PHP_SELF */
-    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('/&amp;/','&',$url);
-        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;
-        }
+    return( $ret );
+}
 
-        if ($k) {
-            if ($val) {
-                $rpl = "$k=$val";
-                if ($link) {
-                    $rpl = preg_replace('/&/','&amp;',$rpl);
-                }
+/**
+ * handy function to set url vars
+ *
+ * especially useful when $url = $PHP_SELF
+ * @param string $url url that must be modified
+ * @param string $var 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('/&amp;/','&',$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 {
-                $rpl = '';
+                $url .= "?$var=$val";
             }
-            if( substr($v,-1)=='&' ) {
-                $rpl .= '&';
+        }
+        break;
+    }
+
+    if ($k) {
+        if ($val) {
+            $rpl = "$k=$val";
+            if ($link) {
+                $rpl = preg_replace('/&/','&amp;',$rpl);
             }
-            $pat = "/$k=$v/";
-            $url = preg_replace($pat,$rpl,$url);
+        } else {
+            $rpl = '';
+        }
+        if( substr($v,-1)=='&' ) {
+            $rpl .= '&';
         }
-        return $url;
+        $pat = "/$k=$v/";
+        $url = preg_replace($pat,$rpl,$url);
     }
+    return $url;
+}
 
-    /* Temporary test function to proces template vars with formatting.
-     * I use it for viewing the message_header (view_header.php) with
-     * a sort of template.
-     */
-    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;
-
-        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++;
-                    }
+/**
+ * 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;
+
+    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];
                 }
-                break;
-            default:
-                break;
-        }
-        if (isset($format_ar[$frm_last]) && $frm_last>$i ) {
-            echo $format_ar[$frm_last];
+                $i++;
+            }
         }
+        break;
+    default:
+        break;
+    }
+    if (isset($format_ar[$frm_last]) && $frm_last>$i ) {
+        echo $format_ar[$frm_last];
     }
+}
 ?>
\ No newline at end of file