HTML_QuickForm_html クラス概要

HTML_QuickForm_html クラス概要 -- フォームに生の HTML を追加するために使用する擬似要素 (廃止予定)

説明

フォーム出力に生の HTML を追加するために使用する擬似要素です。 要素テンプレートが適用されることなく、内容がそのまま出力されます。

警告

この要素は推奨されません。今後はバグ修正や機能変更は行われず、 次のメジャーバージョンでは削除される予定です。 フォームに生の HTML を追加する必要がある場合は、代わりに 'static' 要素の使用を検討してください。

警告

この要素は、 デフォルトのレンダラ と組み合わせた場合にのみ使用可能で、 それ以外のレンダラを使用した場合はこの要素は完全に無視されます。 この機能に頼るのではなく、何らかのテンプレートベースのレンダラを使用することを検討してください。

HTML_QuickForm_html のクラス階層

HTML_QuickForm_html が継承しているメソッド

表 47-1HTML_QuickForm_static から継承したもの

メソッド名概要
コンストラクタ HTML_QuickForm_static::HTML_QuickForm_static()クラスのコンストラクタ
HTML_QuickForm_static::exportValue()静的な要素からは値を受け取る必要がないため、ここでオーバーライドする
HTML_QuickForm_static::getFrozenHtml()HTML タグを含めずにフィールドの値を返す
HTML_QuickForm_static::getName()要素名を返す
HTML_QuickForm_static::onQuickFormEvent()この要素上でイベントが発生した場合に HTML_QuickForm からコールされる
HTML_QuickForm_static::setName()要素名を設定する
HTML_QuickForm_static::setText()テキストを設定する
HTML_QuickForm_static::setValue()テキストを設定する (通常の setValue のコールでフォーム要素をエミュレートするために使用)

表 47-2HTML_QuickForm_element から継承したもの

メソッド名概要
コンストラクタ HTML_QuickForm_element::HTML_QuickForm_element()クラスのコンストラクタ
HTML_QuickForm_element::accept()レンダラを受け入れる
HTML_QuickForm_element::apiVersion()現在の API のバージョンを返す
HTML_QuickForm_element::exportValue()'安全な' 要素の値を返す
HTML_QuickForm_element::freeze()要素を凍結し、その値のみを返す
HTML_QuickForm_element::getFrozenHtml()HTML タグを含めずにフィールドの値を返す
HTML_QuickForm_element::getLabel()要素の表示テキストを返す
HTML_QuickForm_element::getName()要素名を返す
HTML_QuickForm_element::getType()要素の型を返す
HTML_QuickForm_element::getValue()フォーム要素の値を返す
HTML_QuickForm_element::isFrozen()要素が凍結されているかどうかを返す
HTML_QuickForm_element::onQuickFormEvent()この要素上でイベントが発生した場合に HTML_QuickForm からコールされる
HTML_QuickForm_element::setLabel()要素の表示テキストを設定する
HTML_QuickForm_element::setName()入力フィールドの名前を設定する
HTML_QuickForm_element::setPersistantFreeze()要素の値を、それが凍結されているかどうかにかかわらず hidden フィールドに保持し続けるかどうかを設定する
HTML_QuickForm_element::setValue()フォーム要素の値を設定する
HTML_QuickForm_element::unfreeze()フォーム要素の凍結を解除する