commit 3.1 into the trunk

libs/plugins/function.html_table.php

@@ -1,51 +1,51 @@
 <?php
 /**
  * Smarty plugin
- * 
+ *
  * @package Smarty
  * @subpackage PluginsFunction
  */
 
 /**
  * Smarty {html_table} function plugin
- * 
+ *
  * Type:     function<br>
  * Name:     html_table<br>
  * Date:     Feb 17, 2003<br>
  * Purpose:  make an html table from an array of data<br>
- * 
- * 
+ * Params:
+ * <pre>
+ * - loop       - array to loop through
+ * - cols       - number of columns, comma separated list of column names
+ *                or array of column names
+ * - rows       - number of rows
+ * - table_attr - table attributes
+ * - th_attr    - table heading attributes (arrays are cycled)
+ * - tr_attr    - table row attributes (arrays are cycled)
+ * - td_attr    - table cell attributes (arrays are cycled)
+ * - trailpad   - value to pad trailing cells with
+ * - caption    - text for caption element
+ * - vdir       - vertical direction (default: "down", means top-to-bottom)
+ * - hdir       - horizontal direction (default: "right", means left-to-right)
+ * - inner      - inner loop (default "cols": print $loop line by line,
+ *                $loop will be printed column by column otherwise)
+ * </pre>
  * Examples:
  * <pre>
  * {table loop=$data}
  * {table loop=$data cols=4 tr_attr='"bgcolor=red"'}
  * {table loop=$data cols="first,second,third" tr_attr=$colors}
  * </pre>
- * 
- * @author Monte Ohrt <monte at ohrt dot com> 
- * @author credit to Messju Mohr <messju at lammfellpuschen dot de> 
- * @author credit to boots <boots dot smarty at yahoo dot com> 
+ *
+ * @author Monte Ohrt <monte at ohrt dot com>
+ * @author credit to Messju Mohr <messju at lammfellpuschen dot de>
+ * @author credit to boots <boots dot smarty at yahoo dot com>
  * @version 1.1
- * @link http://smarty.php.net/manual/en/language.function.html.table.php {html_table}
+ * @link http://www.smarty.net/manual/en/language.function.html.table.php {html_table}
  *          (Smarty online manual)
- * @param array $params parameters
- * Input:<br>
- *          - loop = array to loop through
- *          - cols = number of columns, comma separated list of column names
- *                   or array of column names
- *          - rows = number of rows
- *          - table_attr = table attributes
- *          - th_attr = table heading attributes (arrays are cycled)
- *          - tr_attr = table row attributes (arrays are cycled)
- *          - td_attr = table cell attributes (arrays are cycled)
- *          - trailpad = value to pad trailing cells with
- *          - caption = text for caption element 
- *          - vdir = vertical direction (default: "down", means top-to-bottom)
- *          - hdir = horizontal direction (default: "right", means left-to-right)
- *          - inner = inner loop (default "cols": print $loop line by line,
- *                    $loop will be printed column by column otherwise)
- * @param object $template template object
- * @return string 
+ * @param array                    $params   parameters
+ * @param Smarty_Internal_Template $template template object
+ * @return string
  */
 function smarty_function_html_table($params, $template)
 {
@@ -65,7 +65,7 @@ function smarty_function_html_table($params, $template)
     if (!isset($params['loop'])) {
         trigger_error("html_table: missing 'loop' parameter",E_USER_WARNING);
         return;
-    } 
+    }
 
     foreach ($params as $_key => $_value) {
         switch ($_key) {
@@ -84,7 +84,7 @@ function smarty_function_html_table($params, $template)
                     $cols_count = (int)$_value;
                 } else {
                     $cols_count = $cols;
-                } 
+                }
                 break;
 
             case 'rows':
@@ -105,8 +105,8 @@ function smarty_function_html_table($params, $template)
             case 'th_attr':
                 $$_key = $_value;
                 break;
-        } 
-    } 
+        }
+    }
 
     $loop_count = count($loop);
     if (empty($params['rows'])) {
@@ -116,14 +116,14 @@ function smarty_function_html_table($params, $template)
         if (!empty($params['rows'])) {
             /* no cols specified, but rows */
             $cols_count = ceil($loop_count / $rows);
-        } 
-    } 
+        }
+    }
 
     $output = "<table $table_attr>\n";
 
     if (!empty($caption)) {
         $output .= '<caption>' . $caption . "</caption>\n";
-    } 
+    }
 
     if (is_array($cols)) {
         $cols = ($hdir == 'right') ? $cols : array_reverse($cols);
@@ -133,9 +133,9 @@ function smarty_function_html_table($params, $template)
             $output .= '<th' . smarty_function_html_table_cycle('th', $th_attr, $r) . '>';
             $output .= $cols[$r];
             $output .= "</th>\n";
-        } 
+        }
         $output .= "</tr></thead>\n";
-    } 
+    }
 
     $output .= "<tbody>\n";
     for ($r = 0; $r < $rows; $r++) {
@@ -147,21 +147,21 @@ function smarty_function_html_table($params, $template)
             if ($inner != 'cols') {
                 /* shuffle x to loop over rows*/
                 $x = floor($x / $cols_count) + ($x % $cols_count) * $rows;
-            } 
+            }
 
             if ($x < $loop_count) {
                 $output .= "<td" . smarty_function_html_table_cycle('td', $td_attr, $c) . ">" . $loop[$x] . "</td>\n";
             } else {
                 $output .= "<td" . smarty_function_html_table_cycle('td', $td_attr, $c) . ">$trailpad</td>\n";
-            } 
-        } 
+            }
+        }
         $output .= "</tr>\n";
-    } 
+    }
     $output .= "</tbody>\n";
     $output .= "</table>\n";
 
     return $output;
-} 
+}
 
 function smarty_function_html_table_cycle($name, $var, $no)
 {
@@ -169,7 +169,7 @@ function smarty_function_html_table_cycle($name, $var, $no)
         $ret = $var;
     } else {
         $ret = $var[$no % count($var)];
-    } 
+    }
 
     return ($ret) ? ' ' . $ret : '';
 }