PEAR Manual
Prev |  | Next

# HTML_QuickForm_element::onQuickFormEvent()

HTML_QuickForm_element::onQuickFormEvent() -- Called by HTML_QuickForm whenever form event is made on this element (package developer related)

## Synopsis

    require_once 'HTML/QuickForm/element.php';

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

## Description

> Note: This method is not intended to be called directly.

If you are creating your own element, you should override this method and create handlers for each of available QuickForm events.

QuickForm events

`'addElement'`

  This event is sent by HTML_QuickForm::addElement() method when adding a new element to the form. Its handler should usually send `'createElement'` and `'updateValue'` events.

`'createElement'`

  This event is sent by HTML_QuickForm::createElement() method after the element object is instantiated. Its handler should usually call class constructor using the contents of `$arg` as parameters.

`'setGroupValue'`

  The event is sent by HTML_QuickForm_group::setValue() method to each of the grouped elements. The handler generally should set the element's value to `$arg`.

`'updateValue'`

  The event is sent by QuickForm when the element is added to the form and when form default and constant values are set. The handler for this event is the most complex one: it should search for element's value within form's constant, submit (if applicable) and default values (in that order) and set the element's value to the found one.

## Parameter

string `$event`

  Name of event

mixed `$arg`

  event arguments

object `&$caller`

  calling object

## Throws

throws no exceptions thrown

## Note

since 1.0

This function can not be called statically.

Prev | Home | Next
HTML_QuickForm_element::isFrozen() | Up | HTML_QuickForm_element::setLabel()