mirror/php-e107
1
0
Fork 0
mirror of https://github.com/e107inc/e107.git synced 2025-08-13 01:54:12 +02:00
Code Issues Releases Wiki Activity

Improve Form handler - work in progress

Browse Source
This commit is contained in:
secretr
2008-12-12 16:36:45 +00:00
parent 016a4b9e4e
commit cac0e1cf12
2 changed files with 298 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

273
e107_handlers/form_handler.php
View File

@@ -1,33 +1,238 @@
<?php
/*
+ ----------------------------------------------------------------------------+
| e107 website system
|
| <20>Steve Dunstan 2001-2002
| http://e107.org
| jalist@e107.org
|
| Released under the terms and conditions of the
| GNU General Public License (http://gnu.org).
|
| $Source: /cvs_backup/e107_0.8/e107_handlers/form_handler.php,v $
| $Revision: 1.3 $
| $Date: 2008-04-04 21:40:38 $
| $Author: e107steved $
+----------------------------------------------------------------------------+
* e107 website system
*
* Copyright (C) 2001-2008 e107 Inc (e107.org)
* Released under the terms and conditions of the
* GNU General Public License (http://www.gnu.org/licenses/gpl.txt)
*
* Form Handler
*
* $Source: /cvs_backup/e107_0.8/e107_handlers/form_handler.php,v $
* $Revision: 1.4 $
* $Date: 2008-12-12 16:36:45 $
* $Author: secretr $
*
*/
if (!defined('e107_INIT')) { exit; }
/**
* Automate Form fields creation. Produced markup is following e107 CSS/XHTML standards
* If options argument is omitted, default values will be used (which OK most of the time)
* Options are intended to handle some very special cases.
*
* Overall field options format (array or GET string like this one: var1=val1&var2=val2...):
*
* - id => (mixed) custom id attribute value
* if numeric value is passed it'll be just appended to the name e.g. {filed-name}-{value}
* if false is passed id will be not created
* if empty string is passed (or no 'id' option is found)
* in all other cases the value will be used as field id
* default: empty string
*
* - class => (string) field class(es)
* Example: 'tbox select class1 class2 class3'
* NOTE: this will override core classes, so you have to explicit include them!
* default: empty string
*
* - size => (int) size attribute value (used when needed)
* default: 40
*
* - readonly => (bool) readonly attribute
* default: false
*
* - disabled => (bool) disabled attribute
* default: false
*
* - tabindex => (int) tabindex attribute value
* default: inner tabindex counter
*
* - other => (string) additional data
* Example: 'attribute1="value1" attribute2="value2"'
* default: empty string
*/
class e_form
{
var $_tabindex_counter = 0;
var $_tabindex_enabled = true;
var $_cached_attributes = array();
function e_form($enable_tabindex = true)
{
$this->_tabindex_enabled = $enable_tabindex;
}
function text($name, $value, $maxlength = 200, $options = array())
{
$options = $this->format_options('text', $name, $options);
return "<input type='text' name='{$name}' value='{$value}' maxlength={$maxlength}".$this->get_attributes($options)." />";
}
function password($name, $maxlength = 50, $options = array())
{
$options = $this->format_options('text', $name, $options);
return "<input type='password' name='{$name}' value='' maxlength={$maxlength}".$this->get_attributes($options)." />";
}
//------------------ Work in progress START --------------------------->
function textarea($name, $value, $rows, $cols, $options = array())
{
//TODO - Add title to option array
}
//------------------ Work in progress END --------------------------->
function get_attributes($options)
{
$ret = '';
//
foreach ($options as $option => $optval)
{
switch ($option) {
case 'id':
$ret .= $this->_format_id($optval, varset($options['name']));
break;
case 'class':
if(!empty($optval)) $ret .= " class='{$optval}'";
break;
case 'size':
if($optval) $ret .= " size='{$optval}'";
break;
case 'tabindex':
if($optval === false || !$this->_tabindex_enabled) break;
$ret .= " tabindex='".($optval ? $optval : $this->_tabindex_counter++)."'";
break;
case 'readonly':
if($optval) $ret .= " readonly='readonly'";
break;
case 'disabled':
if($optval) $ret .= " disabled='disabled'";
break;
case 'other':
if($optval) $ret .= " $optval";
break;
}
}
return $ret;
}
function _format_id($value, $name)
{
if($value === false) return '';
//format the name first
$name = str_replace(array('[]', '[', ']', '_'), array('', '-', '', '-'), $name);
if(is_numeric($value) && $name) return " id='{$name}-{$value}'";// also useful when name is e.g. name='my_name[]'
elseif(empty($value)) return " id='{$name}'";// also useful when name is e.g. name='my_name[some_id]'
else return " id='{$value}'";
}
/**
* Format options based on the field type,
* merge with default
*
* @param string $type
* @param string $name form name attribute value
* @param array|string $user_options
* @return array merged options
*/
function format_options($type, $name, $user_options)
{
if(is_string($user_options)) parse_str($user_options, $user_options);
$def_options = $this->_default_options($type);
foreach (array_keys($user_options) as $key)
{
if(!isset($def_options[$key])) unset($user_options[$key]);
}
$user_options['name'] = $name; //required for some of the automated tasks
return array_merge($def_options, $user_options);
}
/**
* Get default options array based on the filed type
*
* @param string $type
* @return array default options
*/
function _default_options($type)
{
if(isset($this->_cached_attributes[$type])) return $this->_cached_attributes[$type];
$def_options = array(
'class' => '',
'size' => '',
'readonly' => false,
'disabled' => false,
'tabindex' => $this->_tab_counter,
'other' => ''
);
switch ($type) {
case 'hidden':
$def_options = array('disabled' => false, 'other' => '');
break;
case 'text':
$def_options['class'] = 'tbox input-text';
break;
case 'textarea':
$def_options['class'] = 'tbox textarea';
break;
case 'select':
$def_options['class'] = 'tbox select';
break;
case 'radio':
$def_options['class'] = 'radio';
break;
case 'checkbox':
$def_options['class'] = 'checkbox';
break;
case 'submit':
$def_options['class'] = 'button';
break;
case 'admin_button':
break;
case 'option':
$def_options = array('class' => '', 'other' => '');
break;
}
$this->_cached_attributes[$type] = $def_options;
return $def_options;
}
}
class form {
function form_open($form_method, $form_action, $form_name = "", $form_target = "", $form_enctype = "", $form_js = "") {
$method = ($form_method ? "method='".$form_method."'" : "");
$target = ($form_target ? " target='".$form_target."'" : "");
$name = ($form_name ? " id='".$form_name."' " : " id='myform'");
return "\n<form action='".$form_action."' ".$method.$target.$name.$form_enctype.$form_js.">";
}
function form_text($form_name, $form_size, $form_value, $form_maxlength = FALSE, $form_class = "tbox", $form_readonly = "", $form_tooltip = "", $form_js = "") {
$name = ($form_name ? " id='".$form_name."' name='".$form_name."'" : "");
$value = (isset($form_value) ? " value='".$form_value."'" : "");
@@ -37,7 +242,7 @@ class form {
$tooltip = ($form_tooltip ? " title='".$form_tooltip."'" : "");
return "\n<input class='".$form_class."' type='text' ".$name.$value.$size.$maxlength.$readonly.$tooltip.$form_js." />";
}
function form_password($form_name, $form_size, $form_value, $form_maxlength = FALSE, $form_class = "tbox", $form_readonly = "", $form_tooltip = "", $form_js = "") {
$name = ($form_name ? " id='".$form_name."' name='".$form_name."'" : "");
$value = (isset($form_value) ? " value='".$form_value."'" : "");
@@ -47,14 +252,14 @@ class form {
$tooltip = ($form_tooltip ? " title='".$form_tooltip."'" : "");
return "\n<input class='".$form_class."' type='password' ".$name.$value.$size.$maxlength.$readonly.$tooltip.$form_js." />";
}
function form_button($form_type, $form_name, $form_value, $form_js = "", $form_image = "", $form_tooltip = "") {
$name = ($form_name ? " id='".$form_name."' name='".$form_name."'" : "");
$image = ($form_image ? " src='".$form_image."' " : "");
$tooltip = ($form_tooltip ? " title='".$form_tooltip."' " : "");
return "\n<input class='button' type='".$form_type."' ".$form_js." value='".$form_value."'".$name.$image.$tooltip." />";
}
function form_textarea($form_name, $form_columns, $form_rows, $form_value, $form_js = "", $form_style = "", $form_wrap = "", $form_readonly = "", $form_tooltip = "") {
$name = ($form_name ? " id='".$form_name."' name='".$form_name."'" : "");
$readonly = ($form_readonly ? " readonly='readonly'" : "");
@@ -63,52 +268,52 @@ class form {
$style = ($form_style ? " style='".$form_style."'" : "");
return "\n<textarea class='tbox' cols='".$form_columns."' rows='".$form_rows."' ".$name.$form_js.$style.$wrap.$readonly.$tooltip.">".$form_value."</textarea>";
}
function form_checkbox($form_name, $form_value, $form_checked = 0, $form_tooltip = "", $form_js = "") {
$name = ($form_name ? " id='".$form_name.$form_value."' name='".$form_name."'" : "");
$checked = ($form_checked ? " checked='checked'" : "");
$tooltip = ($form_tooltip ? " title='".$form_tooltip."'" : "");
return "\n<input type='checkbox' value='".$form_value."'".$name.$checked.$tooltip.$form_js." />";
}
function form_radio($form_name, $form_value, $form_checked = 0, $form_tooltip = "", $form_js = "") {
$name = ($form_name ? " id='".$form_name.$form_value."' name='".$form_name."'" : "");
$checked = ($form_checked ? " checked='checked'" : "");
$tooltip = ($form_tooltip ? " title='".$form_tooltip."'" : "");
return "\n<input type='radio' value='".$form_value."'".$name.$checked.$tooltip.$form_js." />";
}
function form_file($form_name, $form_size, $form_tooltip = "", $form_js = "") {
$name = ($form_name ? " id='".$form_name."' name='".$form_name."'" : "");
$tooltip = ($form_tooltip ? " title='".$form_tooltip."'" : "");
return "<input type='file' class='tbox' size='".$form_size."'".$name.$tooltip.$form_js." />";
}
function form_select_open($form_name, $form_js = "") {
return "\n<select id='".$form_name."' name='".$form_name."' class='tbox' ".$form_js." >";
}
function form_select_close() {
return "\n</select>";
}
function form_option($form_option, $form_selected = "", $form_value = "", $form_js = "") {
$value = ($form_value !== FALSE ? " value='".$form_value."'" : "");
$selected = ($form_selected ? " selected='selected'" : "");
return "\n<option".$value.$selected." ".$form_js.">".$form_option."</option>";
}
function form_hidden($form_name, $form_value) {
return "\n<input type='hidden' id='".$form_name."' name='".$form_name."' value='".$form_value."' />";
}
function form_close() {
return "\n</form>";
}
}
/*
Usage
echo $rs->form_open("post", e_SELF, "_blank");
@@ -130,6 +335,6 @@ echo $rs->form_option("Option 4");
echo $rs->form_select_close();
echo $rs->form_close();
*/
?>