導入

なぜ "Controller" なの?

このパッケージは、PageController デザインパターンを実装したものです。 これは、リクエストの受け取りと (受け取った GET データあるいは POST データに依存した) アクションの実行をひとつのページで行うことを意味します。 PageController パターンについては、 Martin Fowler のウェブサイト および WACT プロジェクトのウェブサイト でより詳しく説明されています。

QuickForm においてこれがどのような意味を持つかというと、 ひとつのスクリプト内で、リクエストの内容に応じて さまざまなフォームの表示や入力内容の検証を行うということです。 これにより、複数ページで構成される複雑なフォーム (ウィザードなどを思い浮かべでください) を ほんとうに簡単に作成できるようになります。

PageController パターンの最も基本的な実装は、以下のようになります。

<?php
switch ($_REQUEST['action']) {
    case 'foo': 
        doFoo(); 
        break;
    case 'bar': 
        doBar(); 
        break;
    default:
        echo 'Hello, world!';
}
?>

• HTML_QuickForm_Controller: このクラスは、リクエストからアクション名を抽出して 適切なハンドラをコールします。ここには複数のページが含まれます。

• HTML_QuickForm_Page: このクラス (HTML_QuickForm を継承しています) は、 フォームの各ページを表します。

• HTML_QuickForm_Action: このクラスは、Command デザインパターン (つまり、オブジェクト指向のコールバック) を実装します。

基本的な使用例

このパッケージの機能について理解するため、 HTML_QuickForm チュートリアル の例を HTML_QuickForm_Controller で書き直してみましょう。

<?php
// コントローラを読み込みます
require_once 'HTML/QuickForm/Controller.php';
// 基底アクションクラスを読み込みます
// (これを継承したクラスをあとで作成します)
require_once 'HTML/QuickForm/Action.php';

// フォームを表すクラス
class FirstPage extends HTML_QuickForm_Page
{
    function buildForm()
    {
        $this->_formBuilt = true;

        // フォームに要素を追加します
        $this->addElement('header', null, 'QuickForm tutorial example');
        $this->addElement('text', 'name', 'Enter your name:', array('size' => 50, 'maxlength' => 255));
        // submit ボタンの名前を設定する方法に注意してください
        $this->addElement('submit', $this->getButtonName('submit'), 'Send');

        // フィルタと検証ルールを追加します
        $this->applyFilter('name', 'trim');
        $this->addRule('name', 'Please enter your name', 'required', null, 'client');

        $this->setDefaultAction('submit');
    }
}

// フォームを処理するアクション
class ActionProcess extends HTML_QuickForm_Action
{
    function perform(&$page, $actionName)
    {
        echo '<h1>Hello, ' . htmlspecialchars($page->exportValue('name')) . '!</h1>';
    }
}

$page =& new FirstPage('firstForm');

// 'process' ハンドラのみを追加します
// コントローラはこれをデフォルトとして使用します
$page->addAction('process', new ActionProcess());

// コントローラをインスタンス化します
$controller =& new HTML_QuickForm_Controller('tutorial');

// フォーム要素のデフォルト値を設定します
$controller->setDefaults(array(
    'name' => 'Joe User'
));

// コントローラにページを追加します
$controller->addPage($page);

// リクエストを処理します
$controller->run();
?>

もとのコードより冗長になってしまっていると思われるかもしれません。 確かにそのとおりですが、3 ページからなるウィザード形式のフォームを 作成する場合のことを考えてみましょう。HTML_QuickForm_Controller を使用している場合は、 HTML_QuickForm_Page のサブクラスを 3 つ作成し、 HTML_QuickForm_Action に基づいた 'process' イベントのハンドラを作成して それらをコントローラに追加するだけですみます。 しかし、HTML_QuickForm_Controller を使用していない場合は 大量のプログラミングが必要となることでしょう。

<?php
$this->_formBuilt = true;
?>

<?php
$this->addElement('submit', $this->getButtonName('submit'), 'Send');
?>

<?php
$this->setDefaultAction('submit');
?>

<?php
$page =& new FirstPage('firstForm');
?>

<?php
$page->addAction('process', new ActionProcess());
?>

<?php
$controller =& new HTML_QuickForm_Controller('tutorial');
?>

<?php
$controller->setDefaults(array(
    'name' => 'Joe User'
));
$controller->addPage($page);
?>

<?php
$controller->run();
?>

高度な使用例

は、パッケージのアーカイブに含まれています。 上で説明した例と似たものに加えて、 さらに 2 つの複数ページフォームの例が含まれています。

• ウィザード: フォームの各ページには 'Next' ボタンおよび 'Back' ボタンが含まれており、 現在のページの入力内容が有効でない限り次のページには進めません。

• タブ形式のフォーム: フォームはいくつかのページで構成されており、 対応するページに直接ボタンで移動できます。 共通 'Submit' ボタンが押されたときにのみ 入力内容が検証されます。