HTML_QuickFormとの格闘その1～基本編

「HTML_QuickForm からの脱却」とか「QF Haters」とかを読む限りでは、MojaviやMapleなどのMVCフレームワークを使いこなせる人にとって、HTML_QuickFormはもはや使い勝手の悪いモノでしかないそうです(Mapleって初めて知りますた。デザイナさんもプロジェクトに参加してるってすばらしい)。

でも、僕は最近ようやっとSmartyが使えるようになった程度だし、PEARもDBとAuthとPagerくらいしか使ったことないし、第一フレームワークがちんぷんかんぷんなので(決定打)、ある意味上級者になるための踏み絵と思いながらHTML_QuickFormをベンキョしてみようと思いますです。最終目標はHTML_Quickform+Smartyの独自レンダリング。入力→確認→完了の遷移ってHTML_Quickform_Controller使わないとムリかしら？

で、とりあえず「html_quickform」のググり一覧をかたっぱしから見ながらやってみました。以下、テストコードにづらづら書いた自分用コメントもまとめて載せます。

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=EUC-JP">
    <title>Testing PEAR HTML_QuickForm</title>
</head>
<body>

<?php

if (isset($_POST)) {
    print_r($_POST);
}

/*******************************************************************************
大きな流れ
********************************************************************************
addElement:オブジェクト設定
↓
addRule:検証ルール設定
↓
applyFilter:フィルタ設定。trimしたりとか
↓
validate:検証実施
↓
freeze:凍結実施(検証がOKだったら)
↓
(validateの上じゃなくてココでやっていいの？)
setDefaults:デフォルト値設定
setConstants:定数設定(上書きできない値。使いどころがイメージできない...)
↓
display:表示実施(freezeされてれば凍結済み(編集不可能なやつ、いわゆる確認用)画面が表示される)

********************************************************************************
addElement()
********************************************************************************
フォームオブジェクト設定。

addElement('種類', 'フォームオブジェクト名', 'ラベル');
のように呼び出すらしい。種類は定型的に決まってるみたい。

種類：
    header:ヘッダ。使わね
    reset:クリア。使わね
    submit:送信
    button:汎用ボタン

hidden:hidden要素
    text:テキストボックス
    password:パスワード
    select:セレクトボックス
    textarea:複数行テキスト入力ボックス
    radio:ラジオボタン
    advcheckbox:チェックボックス(機能強化版でいい？)
    checkbox:チェックボックス

static:静的文字列。freezeした時のような表示にすること
    html:生のHTML。

フォームオブジェクト名：
    お好きなやつを。他のとかぶるとエラーになるらしい

ラベル：
    やっぱりお好きなやつを。

ex)
*******************************************************************************/

// 送信
addElement('submit', 'btnSubmit', '送信');

// 汎用ボタン
addElement('button', 'btn', 'ぽちっとな');

// hidden(あくまでも例ですよ、user_idはセッション渡しが基本)
addElement('hidden', 'user_id', '10');

// テキストボックス
addElement('text', 'name', 'お名前');

// パスワード
addElement('password', 'password', 'パスワード');

// セレクトボックス(プルダウンするやつ。複数選択ボックスの時はどうするんだろう？)
// 第4引数に選択肢の配列を渡す
$pref = array(1 => '東京都', 2 => '千葉県', 3 => 'さいたまさいたま'...);
addElement('select', 'prefecture', '都道府県', $pref);

// テキストエリア
addElement('textarea', 'note', '注意事項');

// ラジオボタン
addElement('radio', 'sex', '性別', 'オトコ', '1');
addElement('radio', 'sex', '性別', 'オンナ', '2');

//第二引数が同じものを加えていけば、ラジオボタンの完成。でも実際はaddGroupでグループ化する場合があると思う。

$sex[] =& HTML_QuickForm::createElement('radio', 'sex', '性別', 'オトコ', '1');
$sex[] =& HTML_QuickForm::createElement('radio', 'sex', '性別', 'オンナ', '2');
$form->addGroup($sex, 'group','性別', ' ');

//この例だと、<input name="group[sex]" value="1" type="radio"～>と設定される。うーん、group[sex]か。微妙だ...。
//addGroupの第二引数はなくても別に問題ない(ない場合はname="sex"になる)ので、フォームオブジェクト名の衝突がないならば空文字でいいかも。でも第3引数は設定されてないとラベルが出なくなるので、これは設定しておくほうがいい。($sex[]オブジェクトに設定されたラベルは無視されてるっぽい)

// チェックボックス(advcheckbox)
addElement('advcheckbox', 'mag', 'メールマガジン？', 'キボンヌ');

// 静的文字列(あれ？入門ガイドのと違う...。objnameはHTMLに出ないけど、指定しておけばsetDefaultsで上書きできる)
addElement('static', 'objname', 'ラベル文字列', '静的文字列');

// HTML
addElement('html', '<tr><td colspan="2">以下は付属情報れす</td></tr>');

/*******************************************************************************
addRule()
********************************************************************************
検証のルール設定。

addRule('フォームオブジェクト名', 'エラーメッセージ', 'ルール種別');
のように呼び出すらしい。ルール種別は以下の通り。

* required          必須
* maxlength         最大長さ
* rangelength       ？
* regex             正規表現
* email             メール
* emailorblank      メールもしくは空文字
* lettersonly       文字列のみ
* alphanumeric      英数字
* numeric           数字
* nopunctuation     句読点なし
* nonzero           ゼロ以外

でいいのか？ルール種別によっては追加のパラメータが必要な場合もあり。

ex)
*******************************************************************************/
addRule('postcode', '便番号は最大7文字です。', 'maxlength', 7);

//また、ルール種別の後に

addRule('postcode', '便番号は最大7文字です。', 'maxlength', 7, 'client');

//こんな感じで'client'というパラメータを渡せばJavascriptでvalidateするようになるらしい。
//必要ないだろ。つかclientを選んだらserverとclientの両方でやるようにすればいいのに。
//↓
//clientの場合はclientとserverの両方でvalidationしてた。だったらclientにしといたほうが
//ユーザビリティの面からするとbetterだとおもう。

/*******************************************************************************
applyFilter()
********************************************************************************
検証前のGET値/POST値にかけるフィルタ設定。

applyFilter('フォームオブジェクト名', 'フィルタ');
のように呼び出すらしい。

第一引数(フォームオブジェクト名)に「__ALL__」とすると、全要素に対してフィルタされる。
第二引数は

*組み込みフィルタ
*ユーザ定義関数
*配列

が渡せる。2バイト文字のフィルタリングをするなら、多分mb_*系の関数を使ったユーザ定
義関数が必要になるんじゃないかと。

********************************************************************************
validate()
********************************************************************************
検証実施。ルールはaddruleに則る。

********************************************************************************
freeze()
********************************************************************************
凍結実施。入力不可にする(freezing)。

********************************************************************************
display()
********************************************************************************
表示実施。

*/
require_once "HTML/QuickForm.php";

$pref = array('' =>"選択してください", '1' => '東京都', '2' => '千葉県', '3' => 'さいたまさいたま');

$defaults = array(
    'name' => '名無しさん',
    'prefecture' => '3');

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

// オブジェクト設定
$form->addElement('header', 'MyHeader', 'QuickFormのテスト');
$form->addElement('text', 'name', 'あなたのお名前は？');
$form->addElement('password', 'password', 'パスワード');

#$form->addElement('radio', 'sex', '性別', 'オトコ', '1');
#$form->addElement('radio', 'sex', '性別', 'オンナ', '2');

$form->addElement('html', '<tr><td colspan="2">以下は付属情報れす</td></tr>');
$form->addElement('select', 'prefecture', '都道府県', $pref);
$form->addElement('textarea', 'note', '注意事項');
$form->addElement('static', 'staticstr', '<strong>静的文字列</strong>', 'uhi');

$form->addElement('advcheckbox', 'mag', 'メールマガジン？', 'キボンヌ');

$form->addElement('button', 'btn', 'ぽちっとな');

$form->addElement('reset', 'btnClear', 'クリア');
$form->addElement('submit', 'btnSubmit', '送信');

// 検証ルール設定
$form->addRule('name', 'お名前の入力が必要です', 'required',null,'client');

// 検証実施
if ($form->validate()) {
    // 凍結実施
    $form->freeze();
}

$form->setDefaults($defaults);
#$form->setConstants($defaults);
// 表示実施
$form->display();

echo "<a href='{$_SERVER['PHP_SELF']}'>更新</a>";

</body>
</html>

よし、これでなんとなく基本は終了。
最後に参考リンク

HTML_QuickForm
PEAR HTML_QuickForm Getting Started Guide
PEAR初心者ガイド -- HTML_QuickForm入門
 HTML_QuickForm利用の手引き
 HTML_QuickForm : townmedia org
そして次回に続く。

HTML_QuickFormとの格闘その1～基本編

カテゴリ:

このサイトについて

検索

自分用リンク

お友達リンク

My del.icio.us

カテゴリ

人気の高い記事

アイテム

このブログ記事について

HTML_QuickFormとの格闘その1～基本編

カテゴリ:

このサイトについて

検索

自分用リンク

お友達リンク

My del.icio.us

カテゴリ

人気の高い記事

タグクラウド

アイテム

このブログ記事について