X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fforms.php;h=b2899d44d8f3769851a8a52c2a16b93207a025ff;hp=388ce3e409acd2fb48768df423c9967989afa54c;hb=aa6e3b11520522101c7650032837286fe807bb73;hpb=574240f54ed355000c9c4202f80cf3c576d496d6
diff --git a/functions/forms.php b/functions/forms.php
index 388ce3e4..b2899d44 100644
--- a/functions/forms.php
+++ b/functions/forms.php
@@ -1,12 +1,11 @@
$value) {
- $sAttribs.= ' ' . $key . (! is_null($value) ? '="'.htmlspecialchars($value).'"':'');
+ /**
+ * if 'id' is not set, set it to 'name' and replace brackets
+ * with underscores. 'name' might contain field name with squire
+ * brackets (array). Brackets are not allowed in id (validator.w3.org
+ * fails to validate document). According to html 4.01 manual cdata
+ * type description, 'name' attribute uses same type, but validator.w3.org
+ * does not barf on brackets in 'name' attributes.
+ */
+ $aAttribs['id'] = strtr($aAttribs['name'],'[]','__');
}
- return '\n";
+
+ global $oTemplate;
+
+ $oTemplate->assign('type', $sType);
+//FIXME: all the values in the $aAttribs list used to go thru htmlspecialchars()... I would propose that most everything that is assigned to the template should go thru that *in the template class* on its way between here and the actual template file. Otherwise we have to do something like: foreach ($aAttribs as $key => $value) $aAttribs[$key] = htmlspecialchars($value);
+ $oTemplate->assign('aAttribs', $aAttribs);
+
+ return $oTemplate->fetch('input.tpl');
+
}
/**
* 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);
@@ -130,7 +148,8 @@ function addHidden($sName, $sValue, $aAttribs=array()) {
* @param string $sValue initial field value
* @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
+ * @param array $aAttribs (since 1.5.1) extra attributes - should be given
+ * in the form array('attribute_name' => 'attribute_value', ...)
* @return string html formated text input field
*/
function addInput($sName, $sValue = '', $iSize = 0, $iMaxlength = 0, $aAttribs=array()) {
@@ -145,47 +164,78 @@ function addInput($sName, $sValue = '', $iSize = 0, $iMaxlength = 0, $aAttribs=a
/**
* Function to create a selectlist from an array.
- * @param string $sName field name
- * @param array $aValues field values array ( key => value ) ->
- * @param mixed $default the key that will be selected
- * @param boolean $bUsekeys use the keys of the array as option value or not
- * @param array $aAttribs (since 1.5.1) extra attributes
+ * @param string $sName Field name
+ * @param array $aValues Field values array(key => value) results in:
+ * ,
+ * although if $bUsekeys is FALSE, then it changes to:
+ *
+ * @param mixed $default The key(s) that will be selected (it is OK to pass
+ * in an array here in the case of multiple select lists)
+ * @param boolean $bUsekeys Use the keys of the array as option value or not
+ * @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()) {
+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'])) {
- $label_open = '';
- } else {
- $label_open = '';
- $label_close = '';
- }
+ if (! isset($aAttribs['id'])) $aAttribs['id'] = $sName;
- // create attribute string for select tag
- $sAttribs = '';
- foreach ($aAttribs as $key => $value) {
- $sAttribs.= ' ' . $key . (! is_null($value) ? '="'.htmlspecialchars($value).'"':'');
- }
+ // make sure $default is an array, since multiple select lists
+ // need the chance to have more than one default...
+ //
+ if (!is_array($default))
+ $default = array($default);
- $ret = '\n";
- return $ret;
+ global $oTemplate;
+
+//FIXME: all the values in the $aAttribs list and $sName and both the keys and values in $aValues used to go thru htmlspecialchars()... I would propose that most everything that is assigned to the template should go thru that *in the template class* on its way between here and the actual template file. Otherwise we have to do something like: foreach ($aAttribs as $key => $value) $aAttribs[$key] = htmlspecialchars($value); $sName = htmlspecialchars($sName); $aNewValues = array(); foreach ($aValues as $key => $value) $aNewValues[htmlspecialchars($key)] = htmlspecialchars($value); $aValues = $aNewValues; And probably this too because it has to be matched to a value that has already been sanitized: $default = htmlspecialchars($default); (oops, watch out for when $default is an array! (multiple select lists))
+ $oTemplate->assign('aAttribs', $aAttribs);
+ $oTemplate->assign('aValues', $aValues);
+ $oTemplate->assign('bUsekeys', $bUsekeys);
+ $oTemplate->assign('default', $default);
+ $oTemplate->assign('name', $sName);
+ $oTemplate->assign('multiple', $bMultiple);
+ $oTemplate->assign('size', $iSize);
+
+ return $oTemplate->fetch('select.tpl');
+}
+
+/**
+ * Normal button
+ *
+ * Note the switched value/name parameters!
+ * Note also that regular buttons are not very useful unless
+ * used with onclick handlers, thus are only really appropriate
+ * if you use them after having checked if JavaScript is turned
+ * on by doing this: if (checkForJavascript()) ...
+ *
+ * @param string $sValue button name
+ * @param string $sName key name
+ * @param array $aAttribs extra attributes
+ *
+ * @return string html formated submit input field
+ *
+ * @since 1.5.2
+ */
+function addButton($sValue, $sName = null, $aAttribs=array()) {
+ $aAttribs['value'] = $sValue;
+ if (! is_null($sName)) $aAttribs['name'] = $sName;
+ // add default css
+ if (! isset($aAttribs['class'])) $aAttribs['class'] = 'sqmsubmitfield';
+ return addInputField('button', $aAttribs);
}
/**
@@ -203,6 +253,7 @@ function addSubmit($sValue, $sName = null, $aAttribs=array()) {
if (! isset($aAttribs['class'])) $aAttribs['class'] = 'sqmsubmitfield';
return addInputField('submit', $aAttribs);
}
+
/**
* Form reset button
* @param string $sValue button name
@@ -218,77 +269,124 @@ function addReset($sValue, $aAttribs=array()) {
/**
* Textarea form element.
- * @param string $sName field name
- * @param string $sText initial field value
- * @param integer $iCols field width (number of chars)
- * @param integer $iRows field height (number of character rows)
- * @param array $aAttribs (since 1.5.1) extra attributes. function accepts string argument
- * for backward compatibility.
+ *
+ * @param string $sName field name
+ * @param string $sText initial field value (OPTIONAL; default empty)
+ * @param integer $iCols field width (number of chars) (OPTIONAL; default 40)
+ * @param integer $iRows field height (number of character rows) (OPTIONAL; default 10)
+ * @param array $aAttribs (since 1.5.1) extra attributes (OPTIONAL; default empty)
+ *
* @return string html formated text area field
+ *
*/
function addTextArea($sName, $sText = '', $iCols = 40, $iRows = 10, $aAttribs = array()) {
- $label_open = '';
- $label_close = '';
- if (is_array($aAttribs)) {
- // maybe id can default to name?
- if (isset($aAttribs['id'])) {
- $label_open = '';
- }
- // add default css
- if (! isset($aAttribs['class'])) $aAttribs['class'] = 'sqmtextarea';
- // create attribute string (do we have to sanitize keys?)
- $sAttribs = '';
- foreach ($aAttribs as $key => $value) {
- $sAttribs.= ' ' . $key . (! is_null($value) ? '="'.htmlspecialchars($value).'"':'');
- }
- } elseif (is_string($aAttribs)) {
- // backward compatibility mode. deprecated.
- $sAttribs = ' ' . $aAttribs;
- } else {
- $sAttribs = '';
+
+ // no longer accept string arguments for attribs; print
+ // backtrace to help people fix their code
+ //FIXME: throw error instead?
+ if (!is_array($aAttribs)) {
+ echo '$aAttribs argument to addTextArea() must be an array
'; + debug_print_backtrace(); + echo '