Methods

Public

__call()

Magic __call() for addElement() using element helpers.

__construct()

Constructor.

__destruct()

Default destructor; does nothing other than provide a safe fallback for calls to parent::__destruct().

__toString()

Magic __toString() to print out the form automatically.

_postConstruct()

Post-construction tasks to complete object construction.

addDecoratorAttribs()

Adds attributes to a single decorator part, merging with existing attributes.

addElement()

Adds a single element to the form.

addElements()

Adds multiple elements to the form.

addFeedback()

Adds to the form-level feedback message array.

addHtml()

Adds arbitrary raw HTML to the form stack outside the normal element structure.

addProcess()

Adds a submit button named 'process' to the form, using a translated locale key stub as the submit value.

addProcessGroup()

Adds a group of process buttons with an optional label.

auto()

Automatically adds multiple pieces to the form.

beginFieldset()

Begins a <fieldset> block with a legend/caption.

beginGroup()

Begins a group of form elements under a single label.

decorateAsDivs()

When fetching output, render the list and elements inside divs.

decorateAsDlList()

When fetching output, render elements as part of an HTML definition list.

decorateAsPlain()

When fetching output, render elements without any surrounding decoration.

decorateAsTable()

When fetching output, render elements as part of an HTML table.

dump()

Convenience method for getting a dump the whole object, or one of its properties, or an external variable.

endFieldset()

Ends a <fieldset> block.

endGroup()

Ends a group of form elements.

fetch()

Builds and returns the form output, adding a hidden CSRF element as needed.

form()

Main method interface to Solar_View.

getStatus()

Gets the form validation status.

locale()

Looks up class-specific locale strings based on a key.

meta()

Automatically adds attributes and feedback, and sets status, for the form as a whole from a Solar_Form object.

reset()

Resets the form entirely.

setAttrib()

Sets a form-tag attribute.

setAttribs()

Sets multiple form-tag attributes.

setCssClass()

Set the CSS class to use for particular element type.

setCssClasses()

Set the CSS classes to use for various element types.

setDecorator()

Set decoration tag to use for a particular form part.

setDecoratorAttribs()

Resets the attributes on a single decorator part, overwriting the existing attributes.

setDecorators()

Sets the decoration tags to use for various form parts.

setDescrPart()

Sets where the element description goes, 'label' or 'value'.

setLabelSuffix()

Use this suffix string on all labels; for example, ": ".

setStatus()

Sets the form validation status.

Protected

_buildBegin()

Builds the opening <form> tag for output.

_buildConfig()

Builds and returns the default config for a class, including all configs inherited from its parents.

_buildDecoratorBegin()

Builds the beginning of a decorator.

_buildDecoratorEnd()

Builds the end of a decorator.

_buildElement()

Builds a single element label and value for output.

_buildElementBegin()

Builds the beginning decorator of an element.

_buildElementDescr()

Builds the element description for output.

_buildElementEnd()

Builds the ending decorator of an element.

_buildElementInvalid()

Builds the list of "invalid" messages for a single element.

_buildElementLabel()

Builds the label portion of an element for output.

_buildElementLabelInfo()

Modifies the element label information before building for output.

_buildElementListBegin()

Builds the beginning of an element list for output.

_buildElementListEnd()

Builds the ending of an element list for output.

_buildElementValue()

Builds the value portion of an element for output.

_buildElementValueInfo()

Modifies the element value information before building for output.

_buildEnd()

Builds the closing </form> tag for output.

_buildFeedback()

Builds the form-level feedback tag for output.

_buildFieldset()

Builds a fieldset beginning/ending for output.

_buildFieldsetBegin()

Builds the beginning of a fieldset and its legend.

_buildFieldsetEnd()

Builds the end of a fieldset.

_buildGroup()

Builds a group beginning/ending for output.

_buildGroupBegin()

Builds an element group label for output and begins the grouping.

_buildGroupEnd()

Builds the end of an element group.

_buildGroupInvalid()

Builds the list of "invalid" messages while in an element group.

_buildHidden()

Builds the stack of hidden elements for output.

_buildHtml()

Builds added HTML for output.

_buildStack()

Builds the stack of non-hidden elements for output.

_exception()

Convenience method for returning exceptions with localized text.

_fixElementClass()

Fixes the element info 'class' value to add classes for the element type, ID, require, and validation status -- but only if the class is empty to begin with.

_fixElementId()

Fixes the element info 'id' value.

_fixElementName()

Fixes the element info 'name' value; by default, it just throws an exception when the 'name' is empty on non-xhtml element types.

_fixElementType()

Fixes the element info 'type' value; by default, it just throws an exception when the 'type' is empty.

_indent()

Returns text indented to a number of levels, accounting for whether or not we are in a fieldset.

_modCsrfElement()

If a CSRF element is needed but not present, add it; if present and not needed, remove it.

_postConfig()

A hook that activates after _buildConfig() in the constructor.

_preConfig()

A hook that activates before _buildConfig() in the constructor.

_setAttribsForm()

Merges the form-tag attributes in this fashion, with the later ones overriding the earlier ones:

Private

None.