HTML_QuickForm::exportValue()
Prev		Next

HTML_QuickForm::exportValue()

HTML_QuickForm::exportValue() – Returns the element's "safe" value

Synopsis

require_once 'HTML/QuickForm.php';

mixed HTML_QuickForm::exportValue ( string $element )

Description

This method first tries to find a cleaned-up submitted value, it will return a value set by setValue()/setDefaults()/setConstants() if submitted value does not exist for the given element.

The value that couldn't have possibly been submitted (e.g.: an option that is not present in <select> element's option list) is not considered valid and is not returned.

As the values returned by this method and by exportValues() are expected to be immediately processed and/or stored somewhere, values for file elements that obviously have special processing needs are not returned.

Parameter

string $element: Name of the element

Return value

return element value

Throws

Possible PEAR_Error values
Error code	Error message	Reason	Solution
QUICKFORM_NONEXIST_ELEMENT	Element '`$element`' does not exist in HTML_QuickForm::exportValue()	Tried to get a value of a non-existant element	Check the element's name spelling

Note

since 3.1

This function can not be called statically.

Prev	Getting, setting and processing element values	Next
HTML_QuickForm::isSubmitted()	PEAR Manual	HTML_QuickForm::exportValues()