Docs For Class HTML_QuickForm

Class: HTML_QuickForm_hiddenselect

Class: HTML_QuickForm_select

HTML_QuickForm_select::HTML_QuickForm_select(): Class constructor
HTML_QuickForm_select::addOption(): Adds a new OPTION to the SELECT
HTML_QuickForm_select::apiVersion(): Returns the current API version
HTML_QuickForm_select::exportValue(): We check the options and return only the values that _could_ have been
HTML_QuickForm_select::getFrozenHtml(): Returns the value of field without HTML tags
HTML_QuickForm_select::getMultiple(): Returns the select mutiple attribute
HTML_QuickForm_select::getName(): Returns the element name
HTML_QuickForm_select::getPrivateName(): Returns the element name (possibly with brackets appended)
HTML_QuickForm_select::getSelected(): Returns an array of the selected values
HTML_QuickForm_select::getSize(): Returns the select field size
HTML_QuickForm_select::getValue(): Returns an array of the selected values
HTML_QuickForm_select::load(): Loads options from different types of data sources
HTML_QuickForm_select::loadArray(): Loads the options from an associative array
HTML_QuickForm_select::loadDbResult(): Loads the options from DB_result object
HTML_QuickForm_select::loadQuery(): Queries a database and loads the options from the results
HTML_QuickForm_select::onQuickFormEvent()
HTML_QuickForm_select::setMultiple(): Sets the select mutiple attribute
HTML_QuickForm_select::setName(): Sets the input field name
HTML_QuickForm_select::setSelected(): Sets the default values of the select box
HTML_QuickForm_select::setSize(): Sets the select field size, only applies to 'multiple' selects
HTML_QuickForm_select::setValue(): Sets the value of the form element
HTML_QuickForm_select::toHtml(): Returns the SELECT in HTML

Class: HTML_QuickForm_element

HTML_QuickForm_element::HTML_QuickForm_element(): Class constructor
HTML_QuickForm_element::accept(): Accepts a renderer
HTML_QuickForm_element::apiVersion(): Returns the current API version
HTML_QuickForm_element::exportValue(): Returns a 'safe' element's value
HTML_QuickForm_element::freeze(): Freeze the element so that only its value is returned
HTML_QuickForm_element::getFrozenHtml(): Returns the value of field without HTML tags
HTML_QuickForm_element::getLabel(): Returns display text for the element
HTML_QuickForm_element::getName(): Returns the element name
HTML_QuickForm_element::getType(): Returns element type
HTML_QuickForm_element::getValue(): Returns the value of the form element
HTML_QuickForm_element::isFrozen(): Returns whether or not the element is frozen
HTML_QuickForm_element::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element
HTML_QuickForm_element::setLabel(): Sets display text for the element
HTML_QuickForm_element::setName(): Sets the input field name
HTML_QuickForm_element::setPersistantFreeze(): Sets wether an element value should be kept in an hidden field when the element is frozen or not
HTML_QuickForm_element::setValue(): Sets the value of the form element
HTML_QuickForm_element::unfreeze(): Unfreezes the element so that it becomes editable
HTML_QuickForm_element::_findValue(): Tries to find the element value from the values array
HTML_QuickForm_element::_generateId(): Automatically generates and assigns an 'id' attribute for the element.
HTML_QuickForm_element::_getPersistantData(): Used by getFrozenHtml() to pass the element's value if _persistantFreeze is on
HTML_QuickForm_element::_prepareValue(): Used by exportValue() to prepare the value for returning

Class: HTML_Common

HTML_Common::HTML_Common(): Class constructor
HTML_Common::apiVersion(): Returns the current API version
HTML_Common::display(): Displays the HTML to the screen
HTML_Common::getAttribute(): Returns the value of the given attribute
HTML_Common::getAttributes(): Returns the assoc array (default) or string of attributes
HTML_Common::getComment(): Returns the HTML comment
HTML_Common::getTabOffset(): Returns the tabOffset
HTML_Common::removeAttribute(): Removes an attribute
HTML_Common::setAttributes(): Sets the HTML attributes
HTML_Common::setComment(): Sets the HTML comment to be displayed at the beginning of the HTML string
HTML_Common::setLineEnd(): Sets the line end style to Windows, Mac, Unix or a custom string.
HTML_Common::setTab(): Sets the string used to indent HTML
HTML_Common::setTabOffset(): Sets the tab offset
HTML_Common::toHtml(): Abstract method. Must be extended to return the objects HTML
HTML_Common::updateAttributes(): Updates the passed attributes without changing the other existing attributes
HTML_Common::_getAttrKey(): Returns the array key for the given non-name-value pair attribute
HTML_Common::_getAttrString(): Returns an HTML formatted attribute string
HTML_Common::_getLineEnd(): Returns the lineEnd
HTML_Common::_getTab(): Returns a string containing the unit for indenting HTML
HTML_Common::_getTabs(): Returns a string containing the offset for the whole HTML code
HTML_Common::_parseAttributes(): Returns a valid atrributes array from either a string or array
HTML_Common::_removeAttr(): Removes the given attribute from the given array
HTML_Common::_updateAttrArray(): Updates the attributes in $attr1 with the values in $attr2 without changing the other existing attributes

Class Details

[line 37]
This class takes the same arguments as a select element, but instead

of creating a select ring it creates hidden elements for all values already selected with setDefault or setConstant. This is useful if you have a select ring that you don't want visible, but you need all selected values to be passed.

Tags:

author:	Isaac Shepard <ishepard@bsiweb.com>
version:	1.0
since:	2.1
access:	public

Class Methods

constructor HTML_QuickForm_hiddenselect [line 52]

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

Class constructor

Tags:

since:	1.0
access:	public

Parameters:

string	$elementName	Select name attribute
mixed	$elementLabel	Label(s) for the select (not used)
mixed	$options	Data to be used to populate options
mixed	$attributes	Either a typical HTML attribute string or an associative array (not used)

[ Top ]

method accept [line 104]

void accept(

&$renderer)

This is essentially a hidden element and should be rendered as one

Overrides HTML_QuickForm_element::accept() (Accepts a renderer)

Parameters:

&$renderer

[ Top ]

method toHtml [line 73]

string toHtml(
)

Returns the SELECT in HTML

Tags:

since:	1.0
throws:
access:	public

Overrides HTML_QuickForm_select::toHtml() (Returns the SELECT in HTML)

[ Top ]

Documentation generated on Thu, 12 Jun 2008 13:38:46 -0500 by phpDocumentor 1.4.1

Class: HTML_QuickForm_hiddenselect

Class Overview

Author(s):

Version:

Methods

Inherited Variables

Class: HTML_QuickForm_select

Class: HTML_QuickForm_element

Class: HTML_Common

Inherited Methods

Class: HTML_QuickForm_select

Class: HTML_QuickForm_element

Class: HTML_Common

Class Details

Tags:

Class Methods

constructor HTML_QuickForm_hiddenselect [line 52]

Tags:

Parameters:

method accept [line 104]

Parameters:

method toHtml [line 73]

Tags: