array $_attribs = array() (line 62)

Form metadata and attributes

• access: protected

string $_defaultDisplayGroupClass = 'Zend_Form_DisplayGroup' (line 74)

Default display group class

• access: protected

bool $_disableLoadDefaultDecorators = false (line 86)

Should we disable loading the default decorators?

• access: protected

array $_displayGroups = array() (line 98)

Groups of elements grouped for display purposes

• access: protected

array $_elementPrefixPaths = array() (line 110)

Prefix paths to use when creating elements

• access: protected

string $_elementsBelongTo (line 122)

Array to which elements belong (if any)

• access: protected

bool $_errorsExist = false (line 134)

Are there errors in the form?

• access: protected

int|null $_formOrder (line 146)

Form order

• access: protected

bool $_isRendered = false (line 221)

• access: protected

array $_loaders = array() (line 164)

Plugin loaders

• access: protected

array $_order = array() (line 176)

Order in which to display and iterate elements

• access: protected

array $_subFormPrefixPaths = array() (line 188)

Sub form prefix paths

• access: protected

Zend_Translate $_translator (line 199)

• access: protected

Zend_View_Interface $_view (line 216)

• access: protected

static hasDefaultTranslator (line 3012)

Is there a default translation object set?

• access: public

Constructor __construct (line 231)

Constructor

Registers form view helper as decorator

• access: public

• mixed $options

• Zend_Dojo_Form::__construct() : Constructor
• Zend_Dojo_Form_SubForm::__construct() : Constructor

addDecorator (line 2625)

Add a decorator for rendering the element

• access: public

• string|Zend_Form_Decorator_Interface $decorator
• array|Zend_Config $options: Options with which to initialize decorator

addDisplayGroup (line 1781)

Add a display group

Groups named elements for display purposes.

If a referenced element does not yet exist in the form, it is omitted.

• throws: Zend_Form_Exception if no valid elements provided
• access: public

• array $elements
• string $name
• array|Zend_Config $options

addDisplayGroupPrefixPaths (line 612)

Add multiple display group prefix paths at once

• access: public

• array $spec

addElement (line 1015)

Add a new element

$element may be either a string element type, or an object of type Zend_Form_Element. If a string element type is provided, $name must be provided, and $options may be optionally provided for configuring the element.

If a Zend_Form_Element is provided, $name may be optionally provided, and any provided $options will be ignored.

• access: public

• string|Zend_Form_Element $element
• string $name
• array|Zend_Config $options

addElementPrefixPaths (line 574)

Add prefix paths for all elements

• access: public

• array $spec

addError (line 2406)

Add an error message and mark element as failed validation

• access: public

• string $message

addErrorMessages (line 2347)

Add multiple custom error messages to return in the event of failed validation

• access: public

• array $messages

addPrefixPath (line 485)

Add prefix path for plugin loader

If no $type specified, assumes it is a base path for both filters and validators, and sets each according to the following rules:

• decorators: $prefix = $prefix . '_Decorator'
• elements: $prefix = $prefix . '_Element'

If $type is 'decorator', sets the path in the decorator plugin loader for all elements. Additionally, if no $type is provided, the prefix and path is added to both decorator and element plugin loader with following settings: $prefix . '_Decorator', $path . '/Decorator/' $prefix . '_Element', $path . '/Element/'

• throws: Zend_Form_Exception for invalid type
• access: public

• string $prefix
• string $path
• string $type

addSubForm (line 1586)

Add a form group/subform

• access: public

• Zend_Form $form
• string $name
• int $order

clearAttribs (line 734)

Clear all form attributes

• access: public

clearDisplayGroups (line 1994)

Remove all display groups

• access: public

clearErrorMessages (line 2382)

Clear custom error messages stack

• access: public

count (line 3232)

Count of elements/subforms that are iterable

• access: public

Countable::count

current (line 3165)

Current element/subform/display group

• access: public

Iterator::current

getAction (line 758)

Get form action

Sets default to '' if not set.

• access: public

getAttribs (line 708)

Retrieve all form attributes/metadata

• access: public

getDecorator (line 2726)

Retrieve a registered decorator

• access: public

• string $name

getDefaultDisplayGroupClass (line 1763)

Retrieve default display group class

• access: public

getDisplayGroup (line 1941)

Return a display group

• access: public

• string $name

getElement (line 1184)

Retrieve a single element

• access: public

• string $name

getElementsAndSubFormsOrdered (line 2154)

Returns a one dimensional numerical indexed array with the Elements, SubForms and Elements from DisplayGroups as Values.

Subitems are inserted based on their order Setting if set, otherwise they are appended, the resulting numerical index may differ from the order value.

• access: public

getEnctype (line 819)

Get encoding type

• access: public

getErrors (line 2460)

Get error codes for all elements failing validation

• access: public

• string $name
• $suppressArrayNotation

getId (line 888)

Get element id

• access: public

getMessages (line 2501)

Retrieve error messages from elements failing validations

• access: public

• string $name
• bool $suppressArrayNotation

getName (line 866)

Get name attribute

• access: public

getPluginLoader (line 435)

Retrieve plugin loader for given type

$type may be one of:

• decorator
• element

• access: public

• string $type

getSubForms (line 1700)

Retrieve all form subForms/subforms

• access: public

getUnfilteredValue (line 1448)

Get unfiltered element value

• access: public

• string $name

getValidValues (line 1388)

Returns only the valid values from the given form input.

For models that can be saved in a partially valid state, for example when following the builder, prototype or state patterns it is particularly interessting to retrieve all the current valid values to persist them.

• access: public

• array $data
• bool $suppressArrayNotation

getValues (line 1336)

Retrieve all form element values

• access: public

• bool $suppressArrayNotation

hasTranslator (line 2981)

Does this form have its own specific translator?

• access: public

isArray (line 1571)

Get flag indicating if elements belong to an array

• access: public

isValid (line 2209)

Validate the form

• access: public

• array $data

key (line 3188)

Current element/subform/display group name

• access: public

Iterator::key

loadDefaultDecoratorsIsDisabled (line 3254)

Should we load the default decorators?

• access: public

next (line 3199)

Move pointer to next element/subform/display group

• access: public

Iterator::next

populate (line 2023)

Populate form

Proxies to setDefaults()

• access: public

• array $values

removeAttrib (line 719)

Remove attribute

• access: public

• string $key

removeDisplayGroup (line 1967)

Remove a display group by name

• access: public

• string $name

removeSubForm (line 1711)

Remove form subForm/subform

• access: public

• string $name

reset (line 282)

Reset values of form

• access: public

setAction (line 746)

Set form action

• access: public

• string $action

setAttribs (line 681)

Set multiple form attributes at once

Overwrites any previously set attributes.

• access: public

• array $attribs

setDecorators (line 2714)

Overwrite all decorators

• access: public

• array $decorators

setDefaultDisplayGroupClass (line 1752)

Set default display group class

• access: public

• string $class

setDescription (line 940)

Set form description

• access: public

• string $value

setDisableTranslator (line 3023)

Indicate whether or not translation should be disabled

• access: public

• bool $flag

setDisplayGroups (line 1929)

Add multiple display groups (overwrites)

• access: public

• array $groups

setElementFilters (line 1477)

Set all elements' filters

• access: public

• array $filters

setElementsBelongTo (line 1491)

Set name of array elements belong to

• access: public

• string $array

setErrorMessages (line 2361)

Same as addErrorMessages(), but clears custom error message stack first

• access: public

• array $messages

setIsArray (line 1560)

Set flag indicating elements belong to array

• access: public

• bool $flag: Value of flag

setMethod (line 777)

Set form method

Only values in $_methods() allowed

• throws: Zend_Form_Exception
• access: public

• string $method

setOptions (line 309)

Set form state from options array

• access: public

• array $options

setPluginLoader (line 408)

Set plugin loaders for use with decorators and elements

• throws: Zend_Form_Exception on invalid type
• access: public

• Zend_Loader_PluginLoader_Interface $loader
• string $type: 'decorator' or 'element'

setSubForms (line 1674)

Set multiple form subForms/subforms (overwrites)

• access: public

• array $subForms

setView (line 2575)

Set view object

• access: public

• Zend_View_Interface $view

• Zend_Dojo_Form::setView() : Set the view object

valid (line 3221)

Determine if current element/subform/display group is valid

• access: public

Iterator::valid

_array_replace_recursive (line 2184)

This is a helper function until php 5.3 is widespreaded

• access: protected

• array $into

_dissolveArrayUnsetKey (line 2099)

Given an array, an optional arrayPath and a key this method dissolves the arrayPath and unsets the key within the array if it exists.

• access: protected

• array $array
• string|null $arrayPath
• string $key

_getArrayName (line 2036)

Determine array key name from given value

Given a value such as foo[bar][baz], returns the last element (in this case, 'baz').

• access: protected

• string $value

_getErrorMessages (line 3355)

Retrieve optionally translated custom error messages

• access: protected

_loadDecorator (line 3319)

Lazy-load a decorator

• access: protected

• array $decorator: Decorator type and options
• mixed $name: Decorator name or alias

_setIsRendered (line 983)

When calling renderFormElements or render this method

is used to set $_isRendered member to prevent repeatedly merging belongsTo setting

• access: protected

__call (line 3133)

Overloading: allow rendering specific decorators

Call renderDecoratorName() to render a specific decorator.

• throws: Zend_Form_Exception for invalid decorator or invalid method call
• access: public

• string $method
• array $args

__get (line 3045)

Overloading: access to elements, form groups, and display groups

• access: public

• string $name

__set (line 3066)

Overloading: access to elements, form groups, and display groups

• throws: Zend_Form_Exception for invalid $value
• access: public

• string $name
• Zend_Form_Element|Zend_Form $value

__unset (line 3112)

Overloading: access to elements, form groups, and display groups

• access: public

• string $name

ELEMENT = 'ELEMENT' (line 39)

Plugin loader type constants

ENCTYPE_URLENCODED = 'application/x-www-form-urlencoded' (line 54)

Encoding type constants

METHOD_GET = 'get' (line 46)

Method type constants

METHOD_PUT = 'put' (line 48)

Method type constants