4 * forms.php - html form functions
6 * Functions to build forms in a safe and consistent manner.
7 * All attribute values are sanitized with htmlspecialchars().
8 //FIXME: I think the Template class might be better place to sanitize inside assign() method
10 * Currently functions don't provide simple wrappers for file and
11 * image input fields, support only submit and reset buttons and use
12 * html input tags for buttons.
16 * * all form functions should support id tags. Original
17 * idea by dugan <at> passwall.com. Tags can be used for Section 508
20 * * input tag functions accept extra html attributes that can be submitted
23 * * default css class attributes are added.
25 * @link http://www.section508.gov/ Section 508
26 * @link http://www.w3.org/WAI/ Web Accessibility Initiative (WAI)
27 * @link http://www.w3.org/TR/html4/ W3.org HTML 4.01 form specs
28 * @copyright © 2004-2006 The SquirrelMail Project Team
29 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
31 * @package squirrelmail
33 * @since 1.4.3 and 1.5.1
37 * Helper function to create form fields, not to be called directly,
38 * only by other functions below.
40 * Function used different syntax before 1.5.1
41 * @param string $sType type of input field. Possible values (html 4.01
42 * specs.): text, password, checkbox, radio, submit, reset, file,
43 * hidden, image, button.
44 * @param array $aAttribs (since 1.5.1) extra attributes. Array key is
45 * attribute name, array value is attribute value. Array keys must use
47 * @return string html formated input field
48 * @deprecated use other functions that provide simple wrappers to this function
50 function addInputField($sType, $aAttribs=array()) {
52 // define unique identifier
53 if (! isset($aAttribs['id']) && isset($aAttribs['name']) && ! is_null($aAttribs['name'])) {
55 * if 'id' is not set, set it to 'name' and replace brackets
56 * with underscores. 'name' might contain field name with squire
57 * brackets (array). Brackets are not allowed in id (validator.w3.org
58 * fails to validate document). According to html 4.01 manual cdata
59 * type description, 'name' attribute uses same type, but validator.w3.org
60 * does not barf on brackets in 'name' attributes.
62 $aAttribs['id'] = strtr($aAttribs['name'],'[]','__');
67 $oTemplate->assign('type', $sType);
68 //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);
69 $oTemplate->assign('aAttribs', $aAttribs);
71 return $oTemplate->fetch('input.tpl');
76 * Password input field
77 * @param string $sName field name
78 * @param string $sValue initial password value
79 * @param array $aAttribs (since 1.5.1) extra attributes
80 * @return string html formated password field
82 function addPwField($sName, $sValue = null, $aAttribs=array()) {
83 $aAttribs['name'] = $sName;
84 $aAttribs['value'] = (! is_null($sValue) ?
$sValue : '');
86 if (! isset($aAttribs['class'])) $aAttribs['class'] = 'sqmpwfield';
87 return addInputField('password',$aAttribs);
92 * @param string $sName field name
93 * @param boolean $bChecked controls if field is checked
94 * @param string $sValue
95 * @param array $aAttribs (since 1.5.1) extra attributes
96 * @return string html formated checkbox field
98 function addCheckBox($sName, $bChecked = false, $sValue = null, $aAttribs=array()) {
99 $aAttribs['name'] = $sName;
100 if ($bChecked) $aAttribs['checked'] = 'checked';
101 if (! is_null($sValue)) $aAttribs['value'] = $sValue;
103 if (! isset($aAttribs['class'])) $aAttribs['class'] = 'sqmcheckbox';
104 return addInputField('checkbox',$aAttribs);
109 * @param string $sName field name
110 * @param boolean $bChecked controls if field is selected
111 * @param string $sValue
112 * @param array $aAttribs (since 1.5.1) extra attributes.
113 * @return string html formated radio box
115 function addRadioBox($sName, $bChecked = false, $sValue = null, $aAttribs=array()) {
116 $aAttribs['name'] = $sName;
117 if ($bChecked) $aAttribs['checked'] = 'checked';
118 if (! is_null($sValue)) $aAttribs['value'] = $sValue;
119 if (! isset($aAttribs['id'])) $aAttribs['id'] = $sName . $sValue;
121 if (! isset($aAttribs['class'])) $aAttribs['class'] = 'sqmradiobox';
122 return addInputField('radio', $aAttribs);
126 * A hidden form field.
127 * @param string $sName field name
128 * @param string $sValue field value
129 * @param array $aAttribs (since 1.5.1) extra attributes
130 * @return html formated hidden form field
132 function addHidden($sName, $sValue, $aAttribs=array()) {
133 $aAttribs['name'] = $sName;
134 $aAttribs['value'] = $sValue;
136 if (! isset($aAttribs['class'])) $aAttribs['class'] = 'sqmhiddenfield';
137 return addInputField('hidden', $aAttribs);
142 * @param string $sName field name
143 * @param string $sValue initial field value
144 * @param integer $iSize field size (number of characters)
145 * @param integer $iMaxlength maximum number of characters the user may enter
146 * @param array $aAttribs (since 1.5.1) extra attributes - should be given
147 * in the form array('attribute_name' => 'attribute_value', ...)
148 * @return string html formated text input field
150 function addInput($sName, $sValue = '', $iSize = 0, $iMaxlength = 0, $aAttribs=array()) {
151 $aAttribs['name'] = $sName;
152 $aAttribs['value'] = $sValue;
153 if ($iSize) $aAttribs['size'] = (int)$iSize;
154 if ($iMaxlength) $aAttribs['maxlength'] = (int)$iMaxlength;
156 if (! isset($aAttribs['class'])) $aAttribs['class'] = 'sqmtextfield';
157 return addInputField('text', $aAttribs);
161 * Function to create a selectlist from an array.
162 * @param string $sName field name
163 * @param array $aValues field values array(key => value) -> <option value="key">value</option>, although if $bUsekeys is FALSE, then <option value="value">value</option>
164 * @param mixed $default the key that will be selected
165 * @param boolean $bUsekeys use the keys of the array as option value or not
166 * @param array $aAttribs (since 1.5.1) extra attributes
167 * @return string html formated selection box
168 * @todo add attributes argument for option tags and default css
170 function addSelect($sName, $aValues, $default = null, $bUsekeys = false, $aAttribs = array()) {
172 if(count($aValues) == 1) {
173 $k = key($aValues); $v = array_pop($aValues);
174 return addHidden($sName, ($bUsekeys ?
$k:$v), $aAttribs).
175 htmlspecialchars($v) . "\n";
180 //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);
181 $oTemplate->assign('aAttribs', $aAttribs);
182 $oTemplate->assign('aValues', $aValues);
183 $oTemplate->assign('bUsekeys', $bUsekeys);
184 $oTemplate->assign('default', $default);
185 $oTemplate->assign('name', $sName);
187 return $oTemplate->fetch('select.tpl');
191 * Form submission button
192 * Note the switched value/name parameters!
193 * @param string $sValue button name
194 * @param string $sName submitted key name
195 * @param array $aAttribs (since 1.5.1) extra attributes
196 * @return string html formated submit input field
198 function addSubmit($sValue, $sName = null, $aAttribs=array()) {
199 $aAttribs['value'] = $sValue;
200 if (! is_null($sName)) $aAttribs['name'] = $sName;
202 if (! isset($aAttribs['class'])) $aAttribs['class'] = 'sqmsubmitfield';
203 return addInputField('submit', $aAttribs);
207 * @param string $sValue button name
208 * @param array $aAttribs (since 1.5.1) extra attributes
209 * @return string html formated reset input field
211 function addReset($sValue, $aAttribs=array()) {
212 $aAttribs['value'] = $sValue;
214 if (! isset($aAttribs['class'])) $aAttribs['class'] = 'sqmresetfield';
215 return addInputField('reset', $aAttribs);
219 * Textarea form element.
221 * @param string $sName field name
222 * @param string $sText initial field value (OPTIONAL; default empty)
223 * @param integer $iCols field width (number of chars) (OPTIONAL; default 40)
224 * @param integer $iRows field height (number of character rows) (OPTIONAL; default 10)
225 * @param array $aAttribs (since 1.5.1) extra attributes (OPTIONAL; default empty)
227 * @return string html formated text area field
230 function addTextArea($sName, $sText = '', $iCols = 40, $iRows = 10, $aAttribs = array()) {
232 // no longer accept string arguments for attribs; print
233 // backtrace to help people fix their code
234 if (!is_array($aAttribs)) {
235 echo '$aAttribs argument to addTextArea() must be an array<br /><pre>';
236 debug_print_backtrace();
241 // FIXME: should the template do this instead????
242 else if (!isset($aAttribs['class'])) $aAttribs['class'] = 'sqmtextarea';
246 //FIXME: all the values in the $aAttribs list as well as $sName and $sText 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); $sText = htmlspecialchars($sText);
247 $oTemplate->assign('aAttribs', $aAttribs);
248 $oTemplate->assign('name', $sName);
249 $oTemplate->assign('text', $sText);
250 $oTemplate->assign('cols', (int)$iCols);
251 $oTemplate->assign('rows', (int)$iRows);
253 return $oTemplate->fetch('textarea.tpl');
257 * Make a <form> start-tag.
259 * @param string $sAction form handler URL
260 * @param string $sMethod http method used to submit form data. 'get' or 'post'
261 * @param string $sName form name used for identification (used for backward
262 * compatibility). Use of id is recommended instead.
263 * @param string $sEnctype content type that is used to submit data. html 4.01
264 * defaults to 'application/x-www-form-urlencoded'. Form
265 * with file field needs 'multipart/form-data' encoding type.
266 * @param string $sCharset charset that is used for submitted data
267 * @param array $aAttribs (since 1.5.1) extra attributes
269 * @return string html formated form start string
272 function addForm($sAction, $sMethod = 'post', $sName = '', $sEnctype = '', $sCharset = '', $aAttribs = array()) {
276 //FIXME: all the values in the $aAttribs list as well as $charset 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); $sCharset = htmlspecialchars($sCharset);
277 $oTemplate->assign('aAttribs', $aAttribs);
278 $oTemplate->assign('name', $sName);
279 $oTemplate->assign('method', $sMethod);
280 $oTemplate->assign('action', $sAction);
281 $oTemplate->assign('enctype', $sEnctype);
282 $oTemplate->assign('charset', $sCharset);
284 return $oTemplate->fetch('form.tpl');