Previous Class
Solar_Filter_ValidateWord

Solar_Form
Overview

Next Page
Constants

Solar_Form

Form-processing class; also hints the view on how to present the form.

Catalog

This class is part of the Solar_Form package.

Inheritance:

Constants

None.

Public Properties

These are all the public properties in the Solar_Form class.

You can also view the list of all public, protected, and private properties.

$attribs
Attributes for the form tag itself.
$elements
The array of elements in this form.
$feedback
Overall feedback about the state of the form.

Public Methods

These are all the public methods in the Solar_Form class.

You can also view the list of all public, protected, and private methods.

__construct()
Constructor.
__destruct()
Default destructor; does nothing other than provide a safe fallback for calls to parent::__destruct().
addFilter()
Adds one filter to an element.
addFilters()
Adds many filters to one element.
addInvalid()
Adds one or more invalid message to an element, sets the element status to false (invalid), and sets the form status to false (invalid).
addInvalids()
Adds invalidation messages to multiple elements, sets their status to false (invalid) and sets the form status to false (invalid).
apiVersion()
Reports the API version for this class.
dump()
Convenience method for getting a dump the whole object, or one of its properties, or an external variable.
getStatus()
Gets the current overall form validation status.
getValue()
Returns one form element value.
getValues()
Returns the form element values as an array.
load()
Loads form attributes and elements from an external source.
locale()
Looks up class-specific locale strings based on a key.
orderElements()
Reorders the existing elements.
populate()
Automatically populates form elements with specified values.
reset()
Resets the form object to its originally-configured state.
setAttribs()
Sets the attributes of one element.
setElement()
Sets one element in the form.
setElements()
Sets multiple elements in the form.
setFilterLocaleObject()
Tells the internal filter what object it should use for locale translations.
setStatus()
Forcibly sets the overall form validation status.
setType()
Sets the type of one element.
setValue()
Manually set the value of one element.
setValues()
Manually set the value of several elements.
validate()
Applies the filter chain to the form element values; in particular, checks validation and updates the 'invalid' keys for each element that fails.