PHP 5.3 deprecated ereg() function (#2820952)

[squirrelmail.git] / functions / forms.php

diff --git a/functions/forms.php b/functions/forms.php
index 8ec83d4d0701c7926d56d6d0cce572335b057c52..1218d7e81689cb741e234c21e02bc7e5eb8f5f77 100644 (file)
--- a/functions/forms.php
+++ b/functions/forms.php
@@ -25,7 +25,7 @@
  * @link http://www.section508.gov/ Section 508
  * @link http://www.w3.org/WAI/ Web Accessibility Initiative (WAI)
  * @link http://www.w3.org/TR/html4/ W3.org HTML 4.01 form specs
- * @copyright © 2004-2007 The SquirrelMail Project Team
+ * @copyright © 2004-2009 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
@@ -76,12 +76,17 @@ function addInputField($sType, $aAttribs=array()) {
  * Password input field
  * @param string $sName field name
  * @param string $sValue initial password value
- * @param array $aAttribs (since 1.5.1) extra attributes
- * @return string html formated password field
+ * @param integer $iSize field size (number of characters)
+ * @param integer $iMaxlength maximum number of characters the user may enter
+ * @param array $aAttribs (since 1.5.1) extra attributes - should be given
+ *                        in the form array('attribute_name' => 'attribute_value', ...)
+ * @return string html formated password field 
  */
-function addPwField($sName, $sValue = null, $aAttribs=array()) {
+function addPwField($sName, $sValue = '', $iSize = 0, $iMaxlength = 0, $aAttribs=array()) {
     $aAttribs['name']  = $sName;
-    $aAttribs['value'] = (! is_null($sValue) ? $sValue : '');
+    $aAttribs['value'] = $sValue;
+    if ($iSize) $aAttribs['size'] = (int)$iSize;
+    if ($iMaxlength) $aAttribs['maxlength'] = (int)$iMaxlength;
     // add default css
     if (! isset($aAttribs['class'])) $aAttribs['class'] = 'sqmpwfield';
     return addInputField('password',$aAttribs);
@@ -170,18 +175,22 @@ function addInput($sName, $sValue = '', $iSize = 0, $iMaxlength = 0, $aAttribs=a
  * @param array   $aAttribs  (since 1.5.1) Extra attributes
  * @param boolean $bMultiple When TRUE, a multiple select list will be shown
  *                           (OPTIONAL; default is FALSE (single select list))
+ * @param int     $iSize     Desired height of multiple select boxes
+ *                           (OPTIONAL; default is SMOPT_SIZE_NORMAL)
+ *                           (only applicable when $bMultiple is TRUE)
  *
  * @return string html formated selection box
  * @todo add attributes argument for option tags and default css
  */
-function addSelect($sName, $aValues, $default = null, $bUsekeys = false, $aAttribs = array(), $bMultiple = FALSE) {
+function addSelect($sName, $aValues, $default = null, $bUsekeys = false, $aAttribs = array(), $bMultiple = FALSE, $iSize = SMOPT_SIZE_NORMAL) {
     // only one element
-    if(count($aValues) == 1) {
+    if (!$bMultiple && count($aValues) == 1) {
         $k = key($aValues); $v = array_pop($aValues);
-        return addHidden($sName, ($bUsekeys ? $k:$v), $aAttribs).
-            htmlspecialchars($v) . "\n";
+        return addHidden($sName, ($bUsekeys ? $k : $v), $aAttribs)
+             . htmlspecialchars($v);
     }
 
+    if (! isset($aAttribs['id'])) $aAttribs['id'] = $sName;
 
     // make sure $default is an array, since multiple select lists
     // need the chance to have more than one default... 
@@ -199,6 +208,7 @@ function addSelect($sName, $aValues, $default = null, $bUsekeys = false, $aAttri
     $oTemplate->assign('default', $default);
     $oTemplate->assign('name', $sName);
     $oTemplate->assign('multiple', $bMultiple);
+    $oTemplate->assign('size', $iSize);
 
     return $oTemplate->fetch('select.tpl');
 }
@@ -283,6 +293,10 @@ function addTextArea($sName, $sText = '', $iCols = 40, $iRows = 10, $aAttribs =
 
     // add default css
     else if (!isset($aAttribs['class'])) $aAttribs['class'] = 'sqmtextarea';
+    
+    if ( empty( $aAttribs['id'] ) ) {
+        $aAttribs['id'] = strtr($sName,'[]','__');
+    }
 
     global $oTemplate;
 
@@ -327,3 +341,39 @@ function addForm($sAction, $sMethod = 'post', $sName = '', $sEnctype = '', $sCha
     return $oTemplate->fetch('form.tpl');
 }
 
+/**
+  * Creates unique widget names
+  *
+  * Names are formatted as such: "send1", "send2", "send3", etc.,
+  * where "send" in this example is what was given for $base_name
+  *
+  * @param string  $base_name    The name upon which to base the
+  *                              returned widget name.
+  * @param boolean $return_count When TRUE, this function will
+  *                              return the last number used to
+  *                              create a widget name for $base_name
+  *                              (OPTIONAL; default = FALSE).
+  *
+  * @return mixed When $return_output is FALSE, a string containing
+  *               the unique widget name; otherwise an integer with
+  *               the last number used to create the last widget
+  *               name for the given $base_name (where 0 (zero) means
+  *               that no such widgets have been created yet).
+  *
+  * @since 1.5.2
+  *
+  */
+function unique_widget_name($base_name, $return_count=FALSE)
+{
+   static $counts = array();
+
+   if (!isset($counts[$base_name]))
+      $counts[$base_name] = 0;
+
+   if ($return_count)
+      return $counts[$base_name];
+
+   ++$counts[$base_name];
+   return $base_name . $counts[$base_name];
+}
+