Viewing file:  forms.php (5.18 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?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-2010 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id: forms.php 13893 2010-01-25 02:47:41Z 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="'.htmlspecialchars($name).'"' : '').
($value !== null ? ' value="'.htmlspecialchars($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)).
htmlspecialchars($v) . "\n";
}
$ret = '<select name="'.htmlspecialchars($name) . "\">\n";
foreach ($values as $k => $v) {
if(!$usekeys) $k = $v;
$ret .= '<option value="' .
htmlspecialchars( $k ) . '"' .
(($default == $k) ? ' selected="selected"' : '') .
'>' . htmlspecialchars($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="'.htmlspecialchars($name).'" '.
'rows="'.(int)$rows .'" cols="'.(int)$cols.'" '.
$attr . '>'.htmlspecialchars($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="'.htmlspecialchars($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;
}
|