Add 'edit list' type option widget
[squirrelmail.git] / templates / default / select.tpl
index 288abd2b55c4093d1cb20f52f4cb210bb9ee2cd7..9f112eff8e49e2653876243490b961b5e6341e07 100644 (file)
@@ -6,22 +6,29 @@
   * Template for constructing a select input tag.
   *
   * The following variables are available in this template:
-  *      + $name     - The name of the select input
-  *      + $aValues  - An associative array corresponding to each 
-  *                    select option where keys must be used as
-  *                    the option value and the values must be used
-  *                    as the option text
-  *      + $bUsekeys - When FALSE, the value of each option should
-  *                    be the same as the option text instead of
-  *                    using the array key for the option value
-  *      + $default  - The option value that should be selected by default
-  *      + $aAttribs - Any extra attributes: an associative array, where
-  *                    keys are attribute names, and values (which are
-  *                    optional and might be null) should be placed
-  *                    in double quotes as attribute values (optional;
-  *                    may not be present)
+  * string  $name     The name of the select input
+  * array   $aValues  An associative array corresponding to each 
+  *                   select option where keys must be used as
+  *                   the option value and the values must be used
+  *                   as the option text
+  * boolean $bUsekeys When FALSE, the value of each option should
+  *                   be the same as the option text instead of
+  *                   using the array key for the option value
+  * boolean $multiple When TRUE, a multiple select list should be
+  *                   shown.
+  * array   $default  An array of option values that should be 
+  *                   selected by default (only will contain one
+  *                   array element unless this is a multiple select
+  *                   list)
+  * array   $aAttribs Any extra attributes: an associative array, where
+  *                   keys are attribute names, and values (which are
+  *                   optional and might be null) should be placed
+  *                   in double quotes as attribute values (optional;
+  *                   may not be present)
+  * int     $size     The desired height of multiple select boxes (not
+  *                   applicable when $multiple is FALSE)
   *
-  * @copyright © 1999-2006 The SquirrelMail Project Team
+  * @copyright © 1999-2008 The SquirrelMail Project Team
   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
   * @version $Id$
   * @package squirrelmail
@@ -43,7 +50,7 @@ if (isset($aAttribs['id'])) {
 }
 
 
-echo '<select name="' . $name . '"';
+echo '<select name="' . $name . ($multiple ? '[]" multiple="multiple" size="' . $size . '"' : '"');
 foreach ($aAttribs as $key => $value) {
     echo ' ' . $key . (is_null($value) ? '' : '="' . $value . '"');
 }
@@ -52,9 +59,27 @@ echo ">\n";
 
 foreach ($aValues as $key => $value) {
     if (!$bUsekeys) $key = $value;
-    echo '<option value="' .  $key . '"'
-       . (($default == $key) ? ' selected="selected"' : '')
-       . '>' . $label_open . $value . $label_close  . "</option>\n";
+    echo '<option value="' .  $key . '"';
+
+    // multiple select lists have possibly more than one default selection
+    //
+    if ($multiple) {
+        foreach ($default as $def) {
+            if ((string)$def == (string)$key) {
+                echo ' selected="selected"';
+                break;
+            }
+        }
+    }
+
+    // single select widget only needs to check for one default value
+    // (we could use the same code above, but we do this here to increase
+    // efficency and performance)
+    //
+    else if ((string)$default[0] == (string)$key)
+        echo ' selected="selected"';
+
+    echo '>' . $label_open . $value . $label_close  . "</option>\n";
 }
 echo "</select>\n";