HTML_QuickForm_element::apiVersion() (Previous) (Next) HTML_QuickForm_element::freeze()
View this page in Last updated: Sun, 29 Jun 2008
English | Dutch | French | German | Hungarian | Japanese | Polish | Russian | Spanish | Plain HTML

HTML_QuickForm_element::exportValue()

HTML_QuickForm_element::exportValue() -- Returns a 'safe' element's value (package developer related)

Synopsis

require_once 'HTML/QuickForm/element.php';

mixed HTML_QuickForm_element::exportValue (array &$submitValues [, bool $assoc = FALSE])

Description

This method is not intended to be called directly. It is called by HTML_QuickForm::exportValue() and HTML_QuickForm::exportValues() methods.

The method first tries to find a value for itself in a passed array, if such a value is not found it takes the display value via getValue(). It then filters out the values that cannot possibly be submitted by this element and returns the result.

Parameter

array &$submitValues

array of submitted values to search

boolean $assoc

whether to return the value as associative array

Throws

throws no exceptions thrown

See

see getValue(), HTML_QuickForm::exportValue(), HTML_QuickForm::exportValues().

Note

This function can not be called statically.

HTML_QuickForm_element::apiVersion() (Previous) (Next) HTML_QuickForm_element::freeze()
Download Documentation Last updated: Sun, 29 Jun 2008
Do you think that something on this page is wrong? Please file a bug report or add a note.
User Notes:
There are no user contributed notes for this page.