FAQ

説明

この文書は、PEAR general メーリングリスト に投稿された質問を基にして作成されています。 メーリングリストのアーカイブを検索すると、 より詳細な回答や例が見つけられるでしょう。

<form> タグの action 属性を変更する方法は?

HTML_QuickForm_Page のコンストラクタで action 属性を設定できないようになっている唯一の理由は、 間違って自分の足を撃ちぬいてしまうようなミスをしないようにすることです。 どうしても属性を変更したければ、HTML_QuickForm_Page クラスの setAttribute() メソッドあるいは updateAttributes() メソッドを使用します (これらは HTML_Common から継承したものです。このクラスの API についても知っておく必要があります)。

Meta-question: actions

混乱を避けるため、ここでは アクションの名前を表す文字列のことを「アクション」、 HTML_QuickForm_Action のサブクラスのことを「アクションハンドラ」と表記します。

フォームをリセットする方法は?

コントローラは、フォームのデータや検証状態を、 セッション内のコンテナに保持します。このコンテナには container() メソッドを使用してアクセスできます。 フォームをリセットするためには、このコンテナを消去する必要があります。 そのためには、container() に TRUE を渡します。

フォームのページ間で追加のデータを渡す方法は?

答えはきわめて簡単です。HTML_QuickForm_Controller の container() メソッドを使用して、このようにしなければなりません。

// 参照であることに注意 $data =& $page->controller->container(); $data['_my_stuff'] = $stuff;

受け取り側のページでは、以下のようにします。

$data =& $page->controller->container(); $stuff = $data['_my_stuff'];

QFC の将来のバージョンで名前の衝突が起こることを避けるため、 あなたが作成するフィールドには独自のプレフィックスを使用するか、 あるいはアンダースコアで始まる名前を使用してください。

Controller は、あなたが追加したデータについては 何も知らないことに注意しましょう。 exportValues() メソッドや類似のメソッドでこのデータが返されることを期待しないでください。 container() メソッドを使用し、自分でデータを抽出しなければなりません。 しかし、コンテナがリセットされる際には あなたが追加したデータも削除されます。

テンプレートベースのレンダラを使用するには?

まず最初に、HTML_QuickForm_Page が HTML_QuickForm のサブクラスであること、 そのため親クラスの変更内容はすべて子クラスにも適用されるということを 理解してください。 HTML_QuickForm の レンダラについての節 および使用したいレンダラのドキュメントを 読むことをお勧めします。QuickForm 配布物の docs/renderers/ ディレクトリの中に、使用例があります。

すでに説明したとおり、もしページの出力内容をカスタマイズして ページの 'display' アクションの ハンドラとしてこのサブクラスのインスタンスを追加したいのなら、 HTML_QuickForm_Action_Display クラスのサブクラスを作成しなければなりません。 レンダラ固有のコードは、すべてその _renderForm() に含めます。

Controller によって発生する唯一の新しい問題は、 getButtonName() を使用してアクションにバインドしたボタンです。 動的なレンダラを使用している場合は、これは問題にはなりません。 というのも、要素の名前に気を使う必要がないからです。しかし、 静的なレンダラを使用してフォームを出力する場合には、 要素の名前を知っておく必要があります。

ここでは ITStatic レンダラを使用すると仮定しますが、 それ以外の静的レンダラでも同じようになります。 基本的に、3 つの選択肢があります。

1. getButtonName() で自動生成された名前を使用して、ボタン/プレースホルダを フォームに手動で追加します。この方法は 推奨されません。なぜなら、名前を気にするのは Controller 自身のみであるべきで、 直接使用すべきものではないからです。

2. 自動的に命名されたボタンを グループ に追加します。グループにはお好みの名前をつけることができますが、 $appendName を false に設定することを忘れないでください。 ITStatic は、プレースホルダ {form_element_html} を発見すると、グループの HTML をそこに代入します。

3. テンプレートの中から getButtonName() をコールします。 テンプレートに次の内容を追加し、

   <input type="submit" value="Bla-bla" name="func_buttonName('action')" ... />

   HTML_QuickForm_Action_Display のサブクラスの _renderForm() メソッドに次の内容を追加します。

   $tpl->setCallbackFunction('buttonName', array(&$page, 'getButtonName'));

   このコードは HTML_Template_Sigma で動作します。 HTML_Template_ITX (X に注意) の場合はもう少し調整しなければなりません。

オプションのページを持つウィザードを作成するには?

この質問に貢献してくれた Donald Lobo に感謝します。

3 つのページからなるウィザードがあるとしましょう。

• ページ 1 には、ユーザに次のページを選択させるコントロールがあります。

• 入力内容に応じて、ユーザはページ 2A あるいはページ 2B のどちらかに移動します。

• ページ 2A および 2B のどちらからもページ 3 に移動します (これは、プログラミングに関する書籍では一般的に StateMachine と呼ばれているものです)。

QFC のデフォルトの HTML_QuickForm_Action_Next および HTML_QuickForm_Action_Back に基づいたアクションハンドラを作成する必要があります。 これは、ページレベルおよびコントローラレベルのどちらでも行うことが可能です。 ページレベルでサブクラスを作成するほうがシンプルですが、 複雑な StateMachine を使用するなら複数のサブクラスを作成することになります。

上の例の場合、ページ 1 の 'next' アクションは、 ユーザの入力内容に応じてページ 2 あるいはページ 3 のいずれかに 'user' を送信します。このハンドラは、訪れなかったほうのページに 大しても 'valid' フラグを設定します。

ページ 2A および 2B の 'back' アクションは、 ユーザをページ 1 に戻します。一方、'next' アクションはページ 3 に移動します。

最後に、ページ 3 の 'back' アクションハンドラは、 ページ 1 での入力内容に応じてページ 2A あるいは 2B のいずれかに移動します。

実際に動作する例は、statemachine.php ファイルです。

クライアント側での検証を使用しています。'Back' ボタンの場合に検証をしないようにするにはどうしたらいいですか?

クライアント側の検証は、フォームの onSubmit ハンドラからコールされます。このハンドラを削除すれば、検証は実行されません。 つまり、ユーザが 'Back' ボタンを押した際に このハンドラを削除しなければならないということです。例えば ボタンの onClick ハンドラに以下のように記述すれば、 これが実現できます。

this.form.onsubmit = null; return true;