HTML_QuickForm_element::onQuickFormEvent()

HTML_QuickForm_element::onQuickFormEvent() – この要素上でフォームイベントが発生した際に HTML_QuickForm からコールされる (package developer related)

Synopsis

require_once 'HTML/QuickForm/element.php';

void HTML_QuickForm_element::onQuickFormEvent ( string $event , mixed $arg , object &$caller )

Description

このメソッドは、直接コールされることを想定していません。

独自の要素を作成する場合は、このメソッドをオーバーライドし、 使用可能な QuickForm イベントのハンドラを作成する必要があります。

'addElement'

このイベントは、フォームに新しい要素を追加する際に HTML_QuickForm::addElement() メソッドから送信されます。そのハンドラからは、通常は 'createElement' および 'updateValue' イベントが送信されます。

'createElement'

このイベントは、要素オブジェクトのインスタンスが作成された後に HTML_QuickForm::createElement() メソッドから送信されます。そのハンドラは、通常は $arg の内容をパラメータに使用して クラスのコンストラクタをコールしなければなりません。

'setGroupValue'

このイベントは、グループ化した各要素について HTML_QuickForm_group::setValue() メソッドから送信されます。そのハンドラは、通常は $arg を要素の値に設定しなければなりません。

'updateValue'

このイベントは、要素がフォームに追加されて フォームのデフォルト値および定数値が設定された際に QuickForm から送信されます。 このイベントのハンドラは、最も複雑なものになります。 このハンドラではフォームの定数値、送信された値 (もし適切なものがあれば) およびデフォルト値をこの順序で探し、 最初に見つかったものをその要素の値として設定します。

Parameter

string $event

イベントの名前。

mixed $arg

イベントの引数。

object &$caller

呼び出し元のオブジェクト。

Throws

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

Note

since 1.0

This function can not be called statically.