PEAR::HTML_QuickForm入门

相信每个PHP程序员都知道PEAR，而PEAR::HTML_QuickForm是PEAR中的一个非常实用的类库，它可以让你动态地创建，验证和显示HTML表单。

主要特点如下：

* 可以创建20种常见的表单；
* 生成兼容性好的XHTML代码
* 提供强大和可扩展的表单验证功能
* 自动化的服务器端验证和过滤
* 可以生成客户端验证代码(JavaScript)。
* 支持文件上传功能 * 支持自定义的表单显示方法
* 支持多种模板引擎，如ITX, Sigma, Flexy, Smarty等
* 可加入自定义的表单元素、验证规则和显示规则。

下载和安装请参看

首先我们来看这样一个例子：

FirstForm.php

require_once("HTML/QuickForm.php");

//建立一个表单对象
$form = new HTML_QuickForm('frmTest', 'post');

 

/*利用该对象的addElement方法增加四个表单元素

addElemment()的三个参数分别表示类型、名称、显示的文字。

*/
$form->addElement('header', 'header', '请登录');
$form->addElement('text', 'name', '用户名：');
$form->addElement('password', 'password', '密码：');
$form->addElement('submit', 'submit', '提交');

//输出到浏览器
$form->display();
?>     

 

输出效果如图：       

     

 

这种方法看起来是不是很酷 J 我们可以快速地创建表单，当然这不是我们使用QuickForm的主要原因，因为使用一些可视化的工具来创建表单似乎更快一些。

 

QuickForm可以创建的表单元素类型：

 

text	autocomplete	password
textarea	hidden	select
hierselect	hiddenselect	checkbox
radio	submit	reset
button	image	file
advcheckbox	date	static
header	link	html

 

处理表单数据

接下来我们加入对表单的处理功能。

 

Form2.php

require_once("HTML/QuickForm.php");
$form = new HTML_QuickForm('frmTest', 'post');
$form->addElement('header', 'header', '请登录');
$form->addElement('text', 'name', '用户名：');
$form->addElement('password', 'password', '密码：');
$form->addElement('submit', '', '提交');

if ($form->validate()) {
    $form->process('say_hello');
} else {
    $form->display();
}

function say_hello($data) {
    print 'Hello, ' . $data['name'];
    print '
';
    print 'Your password is '.$data['password'];
}

?>
    

 

效果：

 

点击提交按钮后

 

 

在这段代码里，我们设计了一个say_hello()函数来处理表单，并通过$form->process()来调用。

输入到表单的数据保存在一个$data数组中，可以传递给say_hello()函数。

 

表单数据验证

我们再次对这段代码进行改进，为其加入表单数据验证功能。

使用户在登录时必须输入用户名和密码，并且用户名长度不能小于三位。

 

Form3.php

require_once("HTML/QuickForm.php");
$form = new HTML_QuickForm('frmTest', 'post');
$form->addElement('header', 'header', '请登录');
$form->addElement('text', 'name', '用户名：');
$form->addElement('password', 'password', '密码：');
$form->addElement('submit', '', '提交');

//加入三条验证规则
$form->addRule('name','用户名不能为空！', 'required');
$form->addRule('name','用户名必须为3位以上字母或数字', 'minlength',3);
$form->addRule('password','密码不能为空！', 'required');

if ($form->validate()) {
    $form->process('say_hello');
} else {
    $form->display();
}

function say_hello($data) {
    print 'Hello, ' . $data['name'];
    print '
';
    print 'Your password is '.$data['password'];
}

?>
    

 

输出效果如图：

 

 

 

 

可以看到我们仅用了以下三行简单的代码来实现数据验证功能，和我们平时所采取的方法相比方便得多。

//加入三条验证规则
$form->addRule('name','用户名不能为空！', 'required');
$form->addRule('name','用户名必须为3位以上字母或数字', 'minlength',3);
$form->addRule('password','密码不能为空！', 'required');

 

addRule()方法的四个参数分别表示规则应用的对象、提醒文字、验证规则的类型(如required表示必须输入，不能为空)、验证规则的参数。

 

PEAR::HTML_QuickForm自带的验证规则如下：

规则名称	参数	规则描述
required		必须输入，不能为空
maxlength	$length	最大字符长度
minlength	$length	最小字符长度
rangelength	$min,$max	字符长度的范围
regex	$rx	输入的数据必须匹配给定的正则表达式
email	true (forDNS heck)	验证email地址的格式（有个可选的选项还可以查看域名是否有效）
lettersonly		只能是英文字母
alphanumeric		只能是英文字母或数字
numeric		只能是数字
nopunctuation		不能包含以下特殊字符: ( ) . / * ^ ? # ! @ $ % + = , " ' > < ~ [ ] { }.
nonzero		不能为零
compare		两次输入必须相同
uploadedfile		表单元素必须包含正确上传文件
maxfilesize	$size	上传文件的最大容量
mimetype	$mime	上传文件的类型，$mime可以是数组，则上传文件的类型必须为其中一种
filename	$file_rx	上传的文件的名称必须满足给定的正则表达式

 

 

 

 

其中compare规则有点特殊，它是指两个表单的输入数据必须相同（如密码确认时）。它的用法如下：

$form->addElement('password','password_1','Enter your password:');
$form->addElement('password','password_2','Enter your password (again):');
$form->addRule(array('password_1','password_2'),
               "Passwords don't match!",'compare');

 

compare也可以用来比较两个表单中输入的数据的大小，如：

$form->addElement('text','min_age','Minimum Age:');
$form->addElement('text','max_age','Maximum Age:');
$form->addRule(array('min_age','max_age'),
               "Minimum Age must be less than Maximum Age",
               'compare','<');

 

 

客户端验证功能

客户端验证：

 

前面有提到使用addRule()来增加一条验证规则，其实addRule()还有第五个参数—client。这个参数用来说明我们将使用的是客户端验证，如果传递了这个参数，则程序会自动生成客户端的Javascript代码来验证表单里的数据。

 

使用客户端验证更加快捷方便，而且可以减轻服务器的负载。

 

Client.php

//加入三条客户端验证规则
$form->addRule('name','用户名不能为空！', 'required','','client');
$form->addRule('name','用户名必须为3位以上字母或数字', 'minlength',3,'client');
$form->addRule('password','密码不能为空！', 'required','','client');

 

效果如图：

 

图1：

 

图2：

 

自定义验证规则：

 

大多数时候我们使用QuickForm自带的验证规则就已经足够了，但如果有时我们需要的数据格式比较特殊那怎么办呢？　QuickForm允许你自定义验证规则。

 

下面的例子中，我们增了一条自定义的规则：用户名必须为Haohappy。

 

CustomValidation.php

require_once("HTML/QuickForm.php");
$form = new HTML_QuickForm('frmTest', 'post');
$form->addElement('header', 'header', '请登录');
$form->addElement('text', 'name', '用户名：');
$form->addElement('password', 'password', '密码：');
$form->addElement('submit', '', '提交');

//加入三条验证规则
$form->addRule('name','用户名不能为空！', 'required');
$form->addRule('name','用户名必须为3位以上字母或数字', 'minlength',3);
$form->addRule('password','密码不能为空！', 'required');

$form->registerRule('Haohappy_only','function','check_haohappy');
$form->addRule('name','用户名必须为Haohappy', 'Haohappy_only');

if ($form->validate()) {
    $form->process('say_hello');
} else {
    $form->display();
}

function say_hello($data) {
    print 'Hello, ' . $data['name'];
    print '
';
    print 'Your password is '.$data['password'];
}

function check_haohappy($element_name, $element_value) {
    if ($element_value == 'Haohappy') {
        return true;
    } else {
        return false;
    }
}

?>

 

效果如图：

 

 

你应该注意到了，代码中我们新增了以下：

 

$form->registerRule('Haohappy_only','function','check_haohappy');
$form->addRule('name','用户名必须为Haohappy', 'Haohappy_only');

 

我们新注册了一个名为“Haohappy_only”的验证规则，并指定这个验证由函数(function) check_haohpapy()来执行。

 

再接下来我们定义一个check_haohpapy()函数，当用户名为Haohappy时返回true，当不为Haohappy时返回false。

function check_haohappy($element_name, $element_value) {
    if ($element_value == 'Haohappy') {
        return true;
    } else {
        return false;
    }
}

 

小结

 

总结一下使用PEAR::HTML_QuickForm的过程：

                                                                                                               

1．  确保PEAR安装正确；

2．  加载HTML_QuickForm

require_once("HTML/QuickForm.php");

 

3．  建立一个表单对象；

$form = new HTML_QuickForm('frmTest', 'post');

 

4．  增加元素(element)和验证规则(rules)；

5．  设计一个表单处理函数(如代码中的say_hello())；

6．  显示表单或对已有的表单进行数据验证和处理。

 

至此，算是入门了呵呵。

 

一些更高级的功能，如结合Smarty模板引擎等继续研究中。