Docs For Class HTML_QuickForm

void HTML_QuickForm_element(
[string
$elementName = null], [mixed
$elementLabel = null], [mixed
$attributes = null])

Class constructor

Since: 1.0
Access: public

Parameters:

string	`$elementName`	—	Name of the element
mixed	`$elementLabel`	—	Label(s) for the element
mixed	`$attributes`	—	Associative array of tag attributes or HTML attributes name="value" pairs

[ Top ]

void accept(
HTML_QuickForm_Renderer
&$renderer, [bool
$required = false], [string
$error = null])

Accepts a renderer

Access: public

Overridden in child classes as:

HTML_QuickForm_group::accept(): Accepts a renderer

HTML_QuickForm_hierselect::accept()

HTML_QuickForm_date::accept()

HTML_QuickForm_header::accept(): Accepts a renderer

HTML_QuickForm_html::accept(): Accepts a renderer

HTML_QuickForm_hidden::accept(): Accepts a renderer

HTML_QuickForm_hiddenselect::accept(): This is essentially a hidden element and should be rendered as one

Parameters:

HTML_QuickForm_Renderer	`&$renderer`	—	renderer object
bool	`$required`	—	Whether an element is required
string	`$error`	—	An error message associated with an element

[ Top ]

float apiVersion(
)

Returns the current API version

Since: 1.0
Access: public

Overridden in child classes as:

HTML_QuickForm_select::apiVersion(): Returns the current API version

[ Top ]

mixed exportValue(
array
&$submitValues, [bool
$assoc = false])

Returns a 'safe' element's value

Access: public

Overridden in child classes as:

HTML_QuickForm_group::exportValue(): As usual, to get the group's value we access its elements and call

HTML_QuickForm_xbutton::exportValue(): Returns a 'safe' element's value

HTML_QuickForm_static::exportValue(): We override this here because we don't want any values from static elements

HTML_QuickForm_input::exportValue(): We don't need values from button-type elements (except submit) and files

HTML_QuickForm_checkbox::exportValue(): Return true if the checkbox is checked, null if it is not checked (getValue() returns false)

HTML_QuickForm_advcheckbox::exportValue(): This element has a value even if it is not checked, thus we override

HTML_QuickForm_radio::exportValue(): Returns the value attribute if the radio is checked, null if it is not

HTML_QuickForm_submit::exportValue(): Only return the value if it is found within $submitValues (i.e. if

HTML_QuickForm_select::exportValue(): We check the options and return only the values that _could_ have been

Parameters:

array	`&$submitValues`	—	array of submitted values to search
bool	`$assoc`	—	whether to return the value as associative array

[ Top ]

void freeze(
)

Freeze the element so that only its value is returned

Access: public

Overridden in child classes as:

HTML_QuickForm_group::freeze()

HTML_QuickForm_xbutton::freeze()

HTML_QuickForm_hidden::freeze(): Freeze the element so that only its value is returned

HTML_QuickForm_reset::freeze(): Freeze the element so that only its value is returned

HTML_QuickForm_file::freeze(): Freeze the element so that only its value is returned

HTML_QuickForm_image::freeze(): Freeze the element so that only its value is returned

HTML_QuickForm_submit::freeze(): Freeze the element so that only its value is returned

HTML_QuickForm_button::freeze(): Freeze the element so that only its value is returned

[ Top ]

string getFrozenHtml(
)

Returns the value of field without HTML tags

Since: 1.0
Access: public

Overridden in child classes as:

HTML_QuickForm_textarea::getFrozenHtml(): Returns the value of field without HTML tags (in this case, value is changed to a mask)

HTML_QuickForm_group::getFrozenHtml(): Returns the value of field without HTML tags

HTML_QuickForm_xbutton::getFrozenHtml()

HTML_QuickForm_static::getFrozenHtml(): Returns the value of field without HTML tags

HTML_QuickForm_link::getFrozenHtml(): Returns the value of field without HTML tags (in this case, value is changed to a mask)

HTML_QuickForm_checkbox::getFrozenHtml(): Returns the value of field without HTML tags

HTML_QuickForm_advcheckbox::getFrozenHtml(): Unlike checkbox, this has to append a hidden input in both

HTML_QuickForm_radio::getFrozenHtml(): Returns the value of field without HTML tags

HTML_QuickForm_password::getFrozenHtml(): Returns the value of field without HTML tags (in this case, value is changed to a mask)

HTML_QuickForm_select::getFrozenHtml(): Returns the value of field without HTML tags

[ Top ]

string getLabel(
)

Returns display text for the element

Since: 1.3
Access: public

[ Top ]

string getName(
)

Returns the element name

Since: 1.0
Access: public

Overridden in child classes as:

HTML_QuickForm_textarea::getName(): Returns the element name

HTML_QuickForm_group::getName(): Returns the group name

HTML_QuickForm_xbutton::getName()

HTML_QuickForm_static::getName(): Returns the element name

HTML_QuickForm_link::getName(): Returns the element name

HTML_QuickForm_input::getName(): Returns the element name

HTML_QuickForm_select::getName(): Returns the element name

[ Top ]

string getType(
)

Returns element type

Since: 1.0
Access: public

[ Top ]

mixed getValue(
)

Returns the value of the form element

Since: 1.0
Access: public

Overridden in child classes as:

HTML_QuickForm_textarea::getValue(): Returns the value of the form element

HTML_QuickForm_group::getValue(): Returns the value of the group

HTML_QuickForm_xbutton::getValue()

HTML_QuickForm_link::getValue(): Returns the value of the form element

HTML_QuickForm_input::getValue(): Returns the value of the form element

HTML_QuickForm_checkbox::getValue(): Returns the value of the form element

HTML_QuickForm_advcheckbox::getValue(): Returns the element's value

HTML_QuickForm_file::getValue(): Returns information about the uploaded file

HTML_QuickForm_select::getValue(): Returns an array of the selected values

[ Top ]

bool isFrozen(
)

Returns whether or not the element is frozen

Since: 1.3
Access: public

[ Top ]

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

Called by HTML_QuickForm whenever form event is made on this element

Since: 1.0
Access: public

Overridden in child classes as:

HTML_QuickForm_group::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element

HTML_QuickForm_hierselect::onQuickFormEvent()

HTML_QuickForm_date::onQuickFormEvent()

HTML_QuickForm_xbutton::onQuickFormEvent()

HTML_QuickForm_static::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element

HTML_QuickForm_input::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element

HTML_QuickForm_checkbox::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element

HTML_QuickForm_advcheckbox::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element

HTML_QuickForm_radio::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element

HTML_QuickForm_file::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element

HTML_QuickForm_select::onQuickFormEvent()

Parameters:

string	`$event`	—	Name of event
mixed	`$arg`	—	event arguments
object	`&$caller`	—	calling object

[ Top ]

void setLabel(
string
$label)

Sets display text for the element

Since: 1.3
Access: public

Parameters:

string $label — Display text for the element

[ Top ]

void setName(
string
$name)

Sets the input field name

Since: 1.0
Access: public

Overridden in child classes as:

HTML_QuickForm_textarea::setName(): Sets the input field name

HTML_QuickForm_group::setName(): Sets the group name

HTML_QuickForm_xbutton::setName()

HTML_QuickForm_static::setName(): Sets the element name

HTML_QuickForm_link::setName(): Sets the input field name

HTML_QuickForm_input::setName(): Sets the input field name

HTML_QuickForm_select::setName(): Sets the input field name

Parameters:

string $name — Input field name attribute

[ Top ]

void setPersistantFreeze(
[bool
$persistant = false])

Sets wether an element value should be kept in an hidden field when the element is frozen or not

Since: 2.0
Access: public

Overridden in child classes as:

HTML_QuickForm_group::setPersistantFreeze()

Parameters:

bool $persistant — True if persistant value

[ Top ]

void setValue(
string
$value)

Sets the value of the form element

Since: 1.0
Access: public

Overridden in child classes as:

HTML_QuickForm_textarea::setValue(): Sets value for textarea element

HTML_QuickForm_group::setValue(): Sets values for group's elements

HTML_QuickForm_hierselect::setValue(): Sets values for group's elements

HTML_QuickForm_date::setValue()

HTML_QuickForm_xbutton::setValue()

HTML_QuickForm_static::setValue(): Sets the text (uses the standard setValue call to emulate a form element.

HTML_QuickForm_link::setValue(): Sets value for textarea element

HTML_QuickForm_input::setValue(): Sets the value of the form element

HTML_QuickForm_checkbox::setValue(): Sets the value of the form element

HTML_QuickForm_advcheckbox::setValue(): Sets the element's value

HTML_QuickForm_file::setValue(): Sets value for file element.

HTML_QuickForm_select::setValue(): Sets the value of the form element

Parameters:

string $value — Default value of the form element

[ Top ]

void unfreeze(
)

Unfreezes the element so that it becomes editable

Since: 3.2.4
Access: public

Overridden in child classes as:

HTML_QuickForm_group::unfreeze()

[ Top ]

Class: HTML_QuickForm_element

Class Overview

Author(s):

Version:

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Method Detail

HTML_QuickForm_element (Constructor) [line 92]

Parameters:

accept [line 413]

Parameters:

apiVersion [line 113]

exportValue [line 450]

Parameters:

freeze [line 205]

getFrozenHtml [line 235]

getLabel [line 323]

getName [line 159]

getType [line 128]

getValue [line 190]

isFrozen [line 275]

onQuickFormEvent [line 370]

Parameters:

setLabel [line 308]

Parameters:

setName [line 144]

Parameters:

setPersistantFreeze [line 292]

Parameters:

setValue [line 175]

Parameters:

unfreeze [line 220]