1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
|
<?php
/**
* forms.php - html form functions
*
* Functions to build HTML forms in a safe and consistent manner.
* All name, value attributes are htmlentitied.
*
* @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-2012 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id: forms.php 14248 2012-01-02 00:18:17Z pdontthink $
* @package squirrelmail
* @subpackage forms
* @since 1.4.3 and 1.5.1
*/
/**
* Helper function to create form fields, not to be called directly,
* only by other functions below.
*/
function addInputField($type, $name = null, $value = null, $attributes = '') {
return '<input type="'.$type.'"'.
($name !== null ? ' name="'.sm_encode_html_special_chars($name).'"' : '').
($value !== null ? ' value="'.sm_encode_html_special_chars($value).'"' : '').
$attributes . " />\n";
}
/**
* Password input field
*/
function addPwField($name , $value = null, $extra_attributes='') {
return addInputField('password', $name , $value, $extra_attributes);
}
/**
* Form checkbox
*/
function addCheckBox($name, $checked = false, $value = null, $extra_attributes='') {
return addInputField('checkbox', $name, $value,
($checked ? ' checked="checked"' : '') . $extra_attributes);
}
/**
* Form radio box
*/
function addRadioBox($name, $checked = false, $value = null) {
return addInputField('radio', $name, $value,
($checked ? ' checked="checked"' : ''));
}
/**
* A hidden form field.
*/
function addHidden($name, $value) {
return addInputField('hidden', $name, $value);
}
/**
* An input textbox.
*/
function addInput($name, $value = '', $size = 0, $maxlength = 0, $extra_attributes='') {
if ($size) {
$extra_attributes .= ' size="'.(int)$size.'"';
}
if ($maxlength) {
$extra_attributes .= ' maxlength="'.(int)$maxlength .'"';
}
return addInputField('text', $name, $value, $extra_attributes);
}
/**
* Function to create a selectlist from an array.
* Usage:
* name: html name attribute
* values: array ( key => value ) -> <option value="key">value</option>
* default: the key that will be selected
* usekeys: use the keys of the array as option value or not
*/
function addSelect($name, $values, $default = null, $usekeys = false)
{
// only one element
if(count($values) == 1) {
$k = key($values); $v = array_pop($values);
return addHidden($name, ($usekeys ? $k:$v)).
sm_encode_html_special_chars($v) . "\n";
}
$ret = '<select name="'.sm_encode_html_special_chars($name) . "\">\n";
foreach ($values as $k => $v) {
if(!$usekeys) $k = $v;
$ret .= '<option value="' .
sm_encode_html_special_chars( $k ) . '"' .
(($default == $k) ? ' selected="selected"' : '') .
'>' . sm_encode_html_special_chars($v) ."</option>\n";
}
$ret .= "</select>\n";
return $ret;
}
/**
* Form submission button
* Note the switched value/name parameters!
*/
function addSubmit($value, $name = null, $extra_attributes='') {
return addInputField('submit', $name, $value, $extra_attributes);
}
/**
* Form reset button, $value = caption
*/
function addReset($value) {
return addInputField('reset', null, $value);
}
/**
* Textarea form element.
*/
function addTextArea($name, $text = '', $cols = 40, $rows = 10, $attr = '') {
return '<textarea name="'.sm_encode_html_special_chars($name).'" '.
'rows="'.(int)$rows .'" cols="'.(int)$cols.'" '.
$attr . '>'.sm_encode_html_special_chars($text) ."</textarea>\n";
}
/**
* Make a <form> start-tag.
*
* @param string $action
* @param string $method
* @param string $name
* @param string $enctype
* @param string $charset
* @param string $extra Any other attributes can be added with this parameter;
* they should use double quotes around attribute values
* (OPTIONAL; default empty)
* @param mixed $add_token When given as a string or as boolean TRUE, a hidden
* input is also added to the form containing a security
* token. When given as TRUE, the input name is "smtoken";
* otherwise the name is the string that is given for this
* parameter. When FALSE, no hidden token input field is
* added. (OPTIONAL; default not used)
*
*/
function addForm($action, $method = 'post', $name = '', $enctype = '', $charset = '', $extra = '', $add_token = FALSE)
{
if($name) {
$name = ' name="'.$name.'"';
}
if($enctype) {
$enctype = ' enctype="'.$enctype.'"';
}
if($charset) {
$charset = ' accept-charset="'.sm_encode_html_special_chars($charset).'"';
}
$form_string = '<form action="'. $action .'" method="'. $method .'"'.
$enctype . $name . $charset . ' ' . $extra . " >\n";
if($add_token) {
$form_string .= '<input type="hidden" value="' . sm_generate_security_token()
. '" name="' . (is_string($add_token) ? $add_token : 'smtoken')
. "\" />\n";
}
return $form_string;
}
|