Methods

Public

__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.
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.
setElement(): Sets one element in the form.
setElements(): Sets multiple elements in the form.
setStatus(): Forcibly sets the overall form validation status.
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.

Protected

_exception(): Convenience method for returning exceptions with localized text.
_populate(): Recursive method to map the submitted values into elements.
_prepareName(): Prepares a name as an array key, if needed.
_values(): Recursively pulls values from elements into an associative array.

Private

None.

Methods

Public

Protected

Private

Local

Navigation