Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Zend_Form

string
$_defaultDisplayGroupClass= ''Zend_Form_DisplayGroup''
Default display group class
'Zend_Form_DisplayGroup'
Details
bool
$_disableLoadDefaultDecorators= 'false'
Should we disable loading the default decorators?
false
Details
array
$_displayGroupPrefixPaths= 'array()'
Display group prefix paths
array()
Details
array
$_displayGroups= 'array()'
Groups of elements grouped for display purposes
array()
Details
null|array
$_elementDecorators= ''
Global decorators to apply to all elements

array
$_elementPrefixPaths= 'array()'
Prefix paths to use when creating elements
array()
Details
array
$_errorMessages= 'array()'
Custom form-level error messages
array()
Details
bool
$_errorsForced= 'false'
Has the form been manually flagged as an error?
false
Details
bool
$_isArray= 'false'
Whether or not form elements are members of an array
false
Details
array
$_methods= 'array('delete''
Allowed form methods
array('delete'
Details
array
$_order= 'array()'
Order in which to display and iterate elements
array()
Details
bool
$_orderUpdated= 'false'
Whether internal order has been updated or not
false
Details
\Zend_Translate
$_translatorDefault= ''
Global default translation adapter

__call(
string $method, array $args
)
:
string
Overloading: allow rendering specific decorators
Call renderDecoratorName() to render a specific decorator.
Name | Type | Description |
---|---|---|
$method | string | |
$args | array |
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Form_Exception | for invalid decorator or invalid method call |

__construct(
mixed $options
=
null
)
:
void
Constructor
Registers form view helper as decorator
Name | Type | Description |
---|---|---|
$options | mixed |

__get(
string $name
)
:
\Zend_Form_Element|\Zend_Form|null
Overloading: access to elements, form groups, and display groups
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
\Zend_Form_Element|\Zend_Form|null |

__isset(
string $name
)
:
boolean
Overloading: access to elements, form groups, and display groups
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
boolean |

__set(
string $name, \Zend_Form_Element|\Zend_Form $value
)
:
void
Overloading: access to elements, form groups, and display groups
Name | Type | Description |
---|---|---|
$name | string | |
$value | \Zend_Form_Element|\Zend_Form |
Exception | Description |
---|---|
\Zend_Form_Exception | for invalid $value |

__toString(
)
:
string
Serialize as string
Proxies to {@link render()}.
Type | Description |
---|---|
string |

__unset(
string $name
)
:
void
Overloading: access to elements, form groups, and display groups
Name | Type | Description |
---|---|---|
$name | string |

_addDisplayGroupObject(
\Zend_Form_DisplayGroup $group, string|null $name
=
null
)
:
\Zend_Form
Add a display group object (used with cloning)
Name | Type | Description |
---|---|---|
$group | \Zend_Form_DisplayGroup | |
$name | string|null |
Type | Description |
---|---|
\Zend_Form |

_array_replace_recursive(
array $into
)
:
void
This is a helper function until php 5.3 is widespreaded
Name | Type | Description |
---|---|---|
$into | array |

_attachToArray(
mixed $value, string $arrayPath
)
:
array
Converts given arrayPath to an array and attaches given value at the end of it.
Name | Type | Description |
---|---|---|
$value | mixed | The value to attach |
$arrayPath | string | Given array path to convert and attach to. |
Type | Description |
---|---|
array |

_dissolveArrayUnsetKey(
array $array, string|null $arrayPath, string $key
)
:
array
Given an array, an optional arrayPath and a key this method dissolves the arrayPath and unsets the key within the array if it exists.
Name | Type | Description |
---|---|---|
$array | array | |
$arrayPath | string|null | |
$key | string |
Type | Description |
---|---|
array |

_dissolveArrayValue(
array $value, string $arrayPath
)
:
string
Extract the value by walking the array using given array path.
Given an array path such as foo[bar][baz], returns the value of the last element (in this case, 'baz').
Name | Type | Description |
---|---|---|
$value | array | Array to walk |
$arrayPath | string | Array notation path of the part to extract |
Type | Description |
---|---|
string |

_getArrayName(
string $value
)
:
string
Determine array key name from given value
Given a value such as foo[bar][baz], returns the last element (in this case, 'baz').
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
string |

_getDecorator(
string $name, null|array $options
)
:
\Zend_Form_Decorator_Interface
Instantiate a decorator based on class name or class name fragment
Name | Type | Description |
---|---|---|
$name | string | |
$options | null|array |
Type | Description |
---|---|
\Zend_Form_Decorator_Interface |

_getErrorMessages(
)
:
array
Retrieve optionally translated custom error messages
Type | Description |
---|---|
array |

_loadDecorator(
array $decorator, mixed $name
)
:
\Zend_Form_Decorator_Interface
Lazy-load a decorator
Name | Type | Description |
---|---|---|
$decorator | array | Decorator type and options |
$name | mixed | Decorator name or alias |
Type | Description |
---|---|
\Zend_Form_Decorator_Interface |

_setElementsBelongTo(
string $name
=
null
)
:
void
Set array to which elements belong
Name | Type | Description |
---|---|---|
$name | string | Element name |

_setIsRendered(
)
:
void
When calling renderFormElements or render this method is used to set $_isRendered member to prevent repeatedly merging belongsTo setting

addDecorator(
string|\Zend_Form_Decorator_Interface $decorator, array|\Zend_Config $options
=
null
)
:
\Zend_Form
Add a decorator for rendering the element
Name | Type | Description |
---|---|---|
$decorator | string|\Zend_Form_Decorator_Interface | |
$options | array|\Zend_Config | Options with which to initialize decorator |
Type | Description |
---|---|
\Zend_Form |

addDisplayGroup(
array $elements, string $name, array|\Zend_Config $options
=
null
)
:
\Zend_Form
Add a display group
Groups named elements for display purposes.
If a referenced element does not yet exist in the form, it is omitted.
Name | Type | Description |
---|---|---|
$elements | array | |
$name | string | |
$options | array|\Zend_Config |
Type | Description |
---|---|
\Zend_Form |
Exception | Description |
---|---|
\Zend_Form_Exception | if no valid elements provided |

addDisplayGroupPrefixPath(
string $prefix, string $path
)
:
\Zend_Form
Add prefix path for all display groups

addDisplayGroupPrefixPaths(
array $spec
)
:
\Zend_Form
Add multiple display group prefix paths at once

addElement(
string|\Zend_Form_Element $element, string $name
=
null, array|\Zend_Config $options
=
null
)
:
\Zend_Form
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.
Name | Type | Description |
---|---|---|
$element | string|\Zend_Form_Element | |
$name | string | |
$options | array|\Zend_Config |
Type | Description |
---|---|
\Zend_Form |
Exception | Description |
---|---|
\Zend_Form_Exception | on invalid element |

addElementPrefixPath(
string $prefix, string $path, string $type
=
null
)
:
\Zend_Form
Add prefix path for all elements
Name | Type | Description |
---|---|---|
$prefix | string | |
$path | string | |
$type | string |
Type | Description |
---|---|
\Zend_Form |

addErrorMessage(
string $message
)
:
\Zend_Form
Add a custom error message to return in the event of failed validation

addErrorMessages(
array $messages
)
:
\Zend_Form
Add multiple custom error messages to return in the event of failed validation

addErrors(
array $messages
)
:
\Zend_Form
Add multiple error messages and flag element as failed validation

addPrefixPath(
string $prefix, string $path, string $type
=
null
)
:
\Zend_Form
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'
Otherwise, the path prefix is set on the appropriate plugin loader.
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/'
Name | Type | Description |
---|---|---|
$prefix | string | |
$path | string | |
$type | string |
Type | Description |
---|---|
\Zend_Form |
Exception | Description |
---|---|
\Zend_Form_Exception | for invalid type |

addSubForm(
\Zend_Form $form, string $name, int $order
=
null
)
:
\Zend_Form
Add a form group/subform
Name | Type | Description |
---|---|---|
$form | \Zend_Form | |
$name | string | |
$order | int |
Type | Description |
---|---|
\Zend_Form |

clearErrorMessages(
)
:
\Zend_Form
Clear custom error messages stack
Type | Description |
---|---|
\Zend_Form |

createElement(
string $type, string $name, array|\Zend_Config $options
=
null
)
:
\Zend_Form_Element
Create an element
Acts as a factory for creating elements. Elements created with this method will not be attached to the form, but will contain element settings as specified in the form object (including plugin loader prefix paths, default decorators, etc.).
Name | Type | Description |
---|---|---|
$type | string | |
$name | string | |
$options | array|\Zend_Config |
Type | Description |
---|---|
\Zend_Form_Element |

current(
)
:
\Zend_Form_Element|\Zend_Form_DisplayGroup|\Zend_Form
Current element/subform/display group
Type | Description |
---|---|
\Zend_Form_Element|\Zend_Form_DisplayGroup|\Zend_Form |

filterName(
string $value, bool $allowBrackets
=
false
)
:
string
Filter a name to only allow valid variable characters
Name | Type | Description |
---|---|---|
$value | string | |
$allowBrackets | bool |
Type | Description |
---|---|
string |

getAttrib(
string $key
)
:
mixed
Retrieve a single form attribute
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |

getCustomMessages(
)
:
array
Retrieve translated custom error messages Proxies to {@link _getErrorMessages()}.
Type | Description |
---|---|
array |

getDecorator(
string $name
)
:
false|\Zend_Form_Decorator_Abstract
Retrieve a registered decorator
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
false|\Zend_Form_Decorator_Abstract |

getDefaultDisplayGroupClass(
)
:
string
Retrieve default display group class
Type | Description |
---|---|
string |

getDefaultTranslator(
)
:
null|\Zend_Translate
Get global default translator object
Type | Description |
---|---|
null|\Zend_Translate |

getElementsAndSubFormsOrdered(
)
:
array
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.
Type | Description |
---|---|
array |

getElementsBelongTo(
)
:
string|null
Get name of array elements belong to
Type | Description |
---|---|
string|null |

getErrors(
string $name
=
null, $suppressArrayNotation
=
false
)
:
array
Get error codes for all elements failing validation
Name | Type | Description |
---|---|---|
$name | string | |
$suppressArrayNotation |
Type | Description |
---|---|
array |

getFullyQualifiedName(
)
:
string
Get fully qualified name
Places name as subitem of array and/or appends brackets.
Type | Description |
---|---|
string |

getMessages(
string $name
=
null, bool $suppressArrayNotation
=
false
)
:
array
Retrieve error messages from elements failing validations
Name | Type | Description |
---|---|---|
$name | string | |
$suppressArrayNotation | bool |
Type | Description |
---|---|
array |

getPluginLoader(
string $type
=
null
)
:
\Zend_Loader_PluginLoader_Interface
Retrieve plugin loader for given type
$type may be one of: - decorator - element
If a plugin loader does not exist for the given type, defaults are created.
Name | Type | Description |
---|---|---|
$type | string |
Type | Description |
---|---|
\Zend_Loader_PluginLoader_Interface |

getTranslator(
)
:
\Zend_Translate|null
Retrieve translator object
Type | Description |
---|---|
\Zend_Translate|null |

getUnfilteredValue(
string $name
)
:
mixed
Get unfiltered element value
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
mixed |

getValidValues(
array $data, bool $suppressArrayNotation
=
false
)
:
array
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.
Name | Type | Description |
---|---|---|
$data | array | |
$suppressArrayNotation | bool |
Type | Description |
---|---|
array |

getValue(
string $name
)
:
mixed
Retrieve value for single element
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
mixed |

getValues(
bool $suppressArrayNotation
=
false
)
:
array
Retrieve all form element values
Name | Type | Description |
---|---|---|
$suppressArrayNotation | bool |
Type | Description |
---|---|
array |

getView(
)
:
\Zend_View_Interface|null
Retrieve view object
If none registered, attempts to pull from ViewRenderer.
Type | Description |
---|---|
\Zend_View_Interface|null |

hasDefaultTranslator(
)
:
boolean
Is there a default translation object set?
Type | Description |
---|---|
boolean |

hasTranslator(
)
:
bool
Does this form have its own specific translator?
Type | Description |
---|---|
bool |

isValid(
array $data
)
:
boolean
Validate the form
Name | Type | Description |
---|---|---|
$data | array |
Type | Description |
---|---|
boolean |

isValidPartial(
array $data
)
:
boolean
Validate a partial form
Does not check for required flags.
Name | Type | Description |
---|---|---|
$data | array |
Type | Description |
---|---|
boolean |

loadDefaultDecorators(
)
:
\Zend_Form
Load the default decorators
Type | Description |
---|---|
\Zend_Form |

loadDefaultDecoratorsIsDisabled(
)
:
bool
Should we load the default decorators?
Type | Description |
---|---|
bool |

markAsError(
)
:
\Zend_Form
Mark the element as being in a failed validation state
Type | Description |
---|---|
\Zend_Form |

populate(
array $values
)
:
\Zend_Form
Populate form
Proxies to {@link setDefaults()}
Name | Type | Description |
---|---|---|
$values | array |
Type | Description |
---|---|
\Zend_Form |

processAjax(
array $data
)
:
string
Process submitted AJAX data
Checks if provided $data is valid, via {@link isValidPartial()}. If so, it returns JSON-encoded boolean true. If not, it returns JSON-encoded error messages (as returned by {@link getMessages()}).
Name | Type | Description |
---|---|---|
$data | array |
Type | Description |
---|---|
string | JSON-encoded boolean true or error messages |

removeAttrib(
string $key
)
:
bool
Remove attribute
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
bool |

removeDecorator(
string $name
)
:
bool
Remove a single decorator
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
bool |

removeDisplayGroup(
string $name
)
:
boolean
Remove a display group by name
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
boolean |

removeElement(
string $name
)
:
boolean
Remove element
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
boolean |

removeFromIteration(
string $name
)
:
void
Remove an element from iteration
Name | Type | Description |
---|---|---|
$name | string | Element/group/form name |

removeSubForm(
string $name
)
:
boolean
Remove form subForm/subform
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
boolean |

setAttribs(
array $attribs
)
:
\Zend_Form
Set multiple form attributes at once
Overwrites any previously set attributes.
Name | Type | Description |
---|---|---|
$attribs | array |
Type | Description |
---|---|
\Zend_Form |

setDefaultTranslator(
\Zend_Translate|\Zend_Translate_Adapter|null $translator
=
null
)
:
void
Set global default translator object
Name | Type | Description |
---|---|---|
$translator | \Zend_Translate|\Zend_Translate_Adapter|null |

setDefaults(
array $defaults
)
:
\Zend_Form
Set default values for elements
Sets values for all elements specified in the array of $defaults.
Name | Type | Description |
---|---|---|
$defaults | array |
Type | Description |
---|---|
\Zend_Form |

setDisableLoadDefaultDecorators(
bool $flag
)
:
\Zend_Form
Set flag to disable loading default decorators

setDisableTranslator(
bool $flag
)
:
\Zend_Form
Indicate whether or not translation should be disabled

setDisplayGroupDecorators(
array $decorators
)
:
\Zend_Form
Set all display group decorators as specified

setElementDecorators(
array $decorators, array|null $elements
=
null, bool $include
=
true
)
:
\Zend_Form
Set all element decorators as specified
Name | Type | Description |
---|---|---|
$decorators | array | |
$elements | array|null | Specific elements to decorate or exclude from decoration |
$include | bool | Whether $elements is an inclusion or exclusion list |
Type | Description |
---|---|
\Zend_Form |

setErrorMessages(
array $messages
)
:
\Zend_Form
Same as addErrorMessages(), but clears custom error message stack first

setErrors(
array $messages
)
:
\Zend_Form
Overwrite any previously set error messages and flag as failed validation

setMethod(
string $method
)
:
\Zend_Form
Set form method
Only values in {@link $_methods()} allowed
Name | Type | Description |
---|---|---|
$method | string |
Type | Description |
---|---|
\Zend_Form |
Exception | Description |
---|---|
\Zend_Form_Exception |

setPluginLoader(
\Zend_Loader_PluginLoader_Interface $loader, string $type
=
null
)
:
\Zend_Form
Set plugin loaders for use with decorators and elements
Name | Type | Description |
---|---|---|
$loader | \Zend_Loader_PluginLoader_Interface | |
$type | string | 'decorator' or 'element' |
Type | Description |
---|---|
\Zend_Form |
Exception | Description |
---|---|
\Zend_Form_Exception | on invalid type |

setTranslator(
\Zend_Translate|\Zend_Translate_Adapter|null $translator
=
null
)
:
\Zend_Form
Set translator object
Name | Type | Description |
---|---|---|
$translator | \Zend_Translate|\Zend_Translate_Adapter|null |
Type | Description |
---|---|
\Zend_Form |