Controller::container()

Controller::container() -- フォームの値のコンテナへの参照を返す

概要

require_once 'HTML/QuickForm/Controller.php';

array &HTML_QuickForm_Controller::container ([bool $reset = FALSE])

説明

セッションの初期化 このパッケージはデータをセッションに保存します。しかし、セッションを自動的には開始 しませんHTML_QuickForm_Controller のインスタンスを作成する前に、自分で session_start() をコールしなければなりません。

フォーム内のページの値やページの検証状態を含むセッション変数への参照を返します。 これは "低レベル" のメソッドです。 単にフォームの値を知りたいだけの場合は exportValues() を使用してください。

コンテナの構造は以下のようになります。
array (
    'defaults'  => array(... フォームのデフォルト値 ...),
    'constants' => array(... フォームの定数値 ...),
    'values'    => array(
        'page1' => array(... このページから送信された値 ...),
        ...
        'pageN' => array(... このページから送信された値 ...)
    ),
    'valid'     => array(
        'page1' => ページの内容が検証されていない場合に null、内容が有効な場合に true、それ以外の場合に false
        ...
        'pageN' => ページの内容が検証されていない場合に null、内容が有効な場合に true、それ以外の場合に false
    )
)

パラメータ

boolean $reset

true の場合は、コンテナをリセットします。つまり、 すべてのデフォルト値、定数値および送信内容を消去します。

例外・エラー

例外はスローされません。

注意

この関数は、スタティックにコールする ことはできません。