Form.php

Show:

inherited

Classes
- \Zend_Form

Table of Contents

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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Form

\Zend_Form
jump to top

Package: Zend\Form

Zend_Form

Implements: \Zend_Validate_Interface
Children: \Zend_Dojo_Form; \Zend_Form_SubForm
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Version: $Id: Form.php 25223 2013-01-17 14:44:54Z frosch $

Constants

 
                DECORATOR
                = 'DECORATOR'

 
                ELEMENT
                = 'ELEMENT'

 
                METHOD_DELETE
                = 'delete'

 
                METHOD_GET
                = 'get'

 
                METHOD_POST
                = 'post'

 
                METHOD_PUT
                = 'put'

 
                ENCTYPE_URLENCODED
                = 'application/x-www-form-urlencoded'

 
                ENCTYPE_MULTIPART
                = 'multipart/form-data'

Properties

array $_attribs = array()

Form metadata and attributes

Default valuearray()Details

Type: array

array $_decorators = array()

Decorators for rendering

Default valuearray()Details

Type: array

string $_defaultDisplayGroupClass = 'Zend_Form_DisplayGroup'

Default display group class

Default value'Zend_Form_DisplayGroup'Details

Type: string

string $_description =

Form description

Details

Type: string

bool $_disableLoadDefaultDecorators = false

Should we disable loading the default decorators?

Default valuefalseDetails

Type: bool

array $_displayGroupPrefixPaths = array()

Display group prefix paths

Default valuearray()Details

Type: array

array $_displayGroups = array()

Groups of elements grouped for display purposes

Default valuearray()Details

Type: array

null|array $_elementDecorators =

Global decorators to apply to all elements

Details

Type: null | array

array $_elementPrefixPaths = array()

Prefix paths to use when creating elements

Default valuearray()Details

Type: array

array $_elements = array()

Form elements

Default valuearray()Details

Type: array

string $_elementsBelongTo =

Array to which elements belong (if any)

Details

Type: string

array $_errorMessages = array()

Custom form-level error messages

Default valuearray()Details

Type: array

bool $_errorsExist = false

Are there errors in the form?

Default valuefalseDetails

Type: bool

bool $_errorsForced = false

Has the form been manually flagged as an error?

Default valuefalseDetails

Type: bool

int|null $_formOrder =

Form order

Details

Type: int | null

bool $_isArray = false

Whether or not form elements are members of an array

Default valuefalseDetails

Type: bool

bool $_isRendered = false

Default valuefalseDetails

Type: bool

string $_legend =

Form legend

Details

Type: string

array $_loaders = array()

Plugin loaders

Default valuearray()Details

Type: array

array $_methods = array('delete', 'get', 'post', 'put')

Allowed form methods

Default valuearray('delete', 'get', 'post', 'put')Details

Type: array

array $_order = array()

Order in which to display and iterate elements

Default valuearray()Details

Type: array

bool $_orderUpdated = false

Whether internal order has been updated or not

Default valuefalseDetails

Type: bool

array $_subFormPrefixPaths = array()

Sub form prefix paths

Default valuearray()Details

Type: array

array $_subForms = array()

Sub forms

Default valuearray()Details

Type: array

\Zend_Translate $_translator =

Details

Type: \Zend_Translate

\Zend_Translate $_translatorDefault =

static

Global default translation adapter

Details

Type: \Zend_Translate

bool $_translatorDisabled = false

is the translator disabled?

Default valuefalseDetails

Type: bool

\Zend_View_Interface $_view =

Details

Type: \Zend_View_Interface

Methods

__call(string $method, array $args) : string

Overloading: allow rendering specific decorators

Call renderDecoratorName() to render a specific decorator.

Parameters

Name	Type	Description
$method	string
$args	array

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Form_Exception	for invalid decorator or invalid method call

__clone() : void

Clone form object and all children

__construct(mixed $options = null) : void

Constructor

Registers form view helper as decorator

Parameters

Name	Type	Description
$options	mixed

__get(string $name) : \Zend_Form_Element | \Zend_Form | null

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

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Form_Element \| \Zend_Form \| null

__isset(string $name) : boolean

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

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
boolean

__set(string $name, \Zend_Form_Element | \Zend_Form $value) : void

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

Parameters

Name	Type	Description
$name	string
$value	\Zend_Form_Element \| \Zend_Form

Throws

Exception	Description
\Zend_Form_Exception	for invalid $value

__toString() : string

Serialize as string

Proxies to render().

Returns

Type	Description
string

__unset(string $name) : void

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

Parameters

Name	Type	Description
$name	string

_addDisplayGroupObject(\Zend_Form_DisplayGroup $group, string | null $name = null) : \Zend_Form

Add a display group object (used with cloning)

Parameters

Name	Type	Description
$group	\Zend_Form_DisplayGroup
$name	string \| null

Returns

Type	Description
\Zend_Form

_array_replace_recursive(array $into) : void

This is a helper function until php 5.3 is widespreaded

Parameters

Name	Type	Description
$into	array

Details

Access: protected

_attachToArray(mixed $value, string $arrayPath) : array

Converts given arrayPath to an array and attaches given value at the end of it.

Parameters

Name	Type	Description
$value	mixed	The value to attach
$arrayPath	string	Given array path to convert and attach to.

Returns

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.

Parameters

Name	Type	Description
$array	array
$arrayPath	string \| null
$key	string

Returns

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').

Parameters

Name	Type	Description
$value	array	Array to walk
$arrayPath	string	Array notation path of the part to extract

Returns

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').

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
string

_getDecorator(string $name, null | array $options) : \Zend_Form_Decorator_Interface

Instantiate a decorator based on class name or class name fragment

Parameters

Name	Type	Description
$name	string
$options	null \| array

Returns

Type	Description
\Zend_Form_Decorator_Interface

_getErrorMessages() : array

Retrieve optionally translated custom error messages

Returns

Type	Description
array

_getIsRendered() : void

Get the value of $_isRendered member

_loadDecorator(array $decorator, mixed $name) : \Zend_Form_Decorator_Interface

Lazy-load a decorator

Parameters

Name	Type	Description
$decorator	array	Decorator type and options
$name	mixed	Decorator name or alias

Returns

Type	Description
\Zend_Form_Decorator_Interface

_setElementsBelongTo(string $name = null) : void

Set array to which elements belong

Parameters

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

_sort() : void

Sort items according to their order

addAttribs(array $attribs) : \Zend_Form

Add multiple form attributes at once

Parameters

Name	Type	Description
$attribs	array

Returns

Type	Description
\Zend_Form

addDecorator(string | \Zend_Form_Decorator_Interface $decorator, array | \Zend_Config $options = null) : \Zend_Form

Add a decorator for rendering the element

Parameters

Name	Type	Description
$decorator	string \| \Zend_Form_Decorator_Interface
$options	array \| \Zend_Config	Options with which to initialize decorator

Returns

Type	Description
\Zend_Form

addDecorators(array $decorators) : \Zend_Form

Add many decorators at once

Parameters

Name	Type	Description
$decorators	array

Returns

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.

Parameters

Name	Type	Description
$elements	array
$name	string
$options	array \| \Zend_Config

Returns

Type	Description
\Zend_Form

Throws

Exception	Description
\Zend_Form_Exception	if no valid elements provided

addDisplayGroupPrefixPath(string $prefix, string $path) : \Zend_Form

Add prefix path for all display groups

Parameters

Name	Type	Description
$prefix	string
$path	string

Returns

Type	Description
\Zend_Form

addDisplayGroupPrefixPaths(array $spec) : \Zend_Form

Add multiple display group prefix paths at once

Parameters

Name	Type	Description
$spec	array

Returns

Type	Description
\Zend_Form

addDisplayGroups(array $groups) : \Zend_Form

Add multiple display groups at once

Parameters

Name	Type	Description
$groups	array

Returns

Type	Description
\Zend_Form

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.

Parameters

Name	Type	Description
$element	string \| \Zend_Form_Element
$name	string
$options	array \| \Zend_Config

Returns

Type	Description
\Zend_Form

Throws

Exception	Description
\Zend_Form_Exception	on invalid element

addElementPrefixPath(string $prefix, string $path, string $type = null) : \Zend_Form

Add prefix path for all elements

Parameters

Name	Type	Description
$prefix	string
$path	string
$type	string

Returns

Type	Description
\Zend_Form

addElementPrefixPaths(array $spec) : \Zend_Form

Add prefix paths for all elements

Parameters

Name	Type	Description
$spec	array

Returns

Type	Description
\Zend_Form

addElements(array $elements) : \Zend_Form

Add multiple elements at once

Parameters

Name	Type	Description
$elements	array

Returns

Type	Description
\Zend_Form

addError(string $message) : \Zend_Form

Add an error message and mark element as failed validation

Parameters

Name	Type	Description
$message	string

Returns

Type	Description
\Zend_Form

addErrorMessage(string $message) : \Zend_Form

Add a custom error message to return in the event of failed validation

Parameters

Name	Type	Description
$message	string

Returns

Type	Description
\Zend_Form

addErrorMessages(array $messages) : \Zend_Form

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

Parameters

Name	Type	Description
$messages	array

Returns

Type	Description
\Zend_Form

addErrors(array $messages) : \Zend_Form

Add multiple error messages and flag element as failed validation

Parameters

Name	Type	Description
$messages	array

Returns

Type	Description
\Zend_Form

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/'

Parameters

Name	Type	Description
$prefix	string
$path	string
$type	string

Returns

Type	Description
\Zend_Form

Throws

Exception	Description
\Zend_Form_Exception	for invalid type

addPrefixPaths(array $spec) : \Zend_Form

Add many prefix paths at once

Parameters

Name	Type	Description
$spec	array

Returns

Type	Description
\Zend_Form

addSubForm(\Zend_Form $form, string $name, int $order = null) : \Zend_Form

Add a form group/subform

Parameters

Name	Type	Description
$form	\Zend_Form
$name	string
$order	int

Returns

Type	Description
\Zend_Form

addSubForms(array $subForms) : \Zend_Form

Add multiple form subForms/subforms at once

Parameters

Name	Type	Description
$subForms	array

Returns

Type	Description
\Zend_Form

clearAttribs() : \Zend_Form

Clear all form attributes

Returns

Type	Description
\Zend_Form

clearDecorators() : \Zend_Form

Clear all decorators

Returns

Type	Description
\Zend_Form

clearDisplayGroups() : \Zend_Form

Remove all display groups

Returns

Type	Description
\Zend_Form

clearElements() : \Zend_Form

Remove all form elements

Returns

Type	Description
\Zend_Form

clearErrorMessages() : \Zend_Form

Clear custom error messages stack

Returns

Type	Description
\Zend_Form

clearSubForms() : \Zend_Form

Remove all form subForms/subforms

Returns

Type	Description
\Zend_Form

count() : int

Count of elements/subforms that are iterable

Returns

Type	Description
int

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.).

Parameters

Name	Type	Description
$type	string
$name	string
$options	array \| \Zend_Config

Returns

Type	Description
\Zend_Form_Element

current() : \Zend_Form_Element | \Zend_Form_DisplayGroup | \Zend_Form

Current element/subform/display group

Returns

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

Parameters

Name	Type	Description
$value	string
$allowBrackets	bool

Returns

Type	Description
string

getAction() : string

Get form action

Sets default to '' if not set.

Returns

Type	Description
string

getAttrib(string $key) : mixed

Retrieve a single form attribute

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

getAttribs() : array

Retrieve all form attributes/metadata

Returns

Type	Description
array

getCustomMessages() : array

Retrieve translated custom error messages Proxies to {@link _getErrorMessages()}.

Returns

Type	Description
array

getDecorator(string $name) : false | \Zend_Form_Decorator_Abstract

Retrieve a registered decorator

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
false \| \Zend_Form_Decorator_Abstract

getDecorators() : array

Retrieve all decorators

Returns

Type	Description
array

getDefaultDisplayGroupClass() : string

Retrieve default display group class

Returns

Type	Description
string

getDefaultTranslator() : null | \Zend_Translate

static

Get global default translator object

Returns

Type	Description
null \| \Zend_Translate

getDescription() : string

Retrieve form description

Returns

Type	Description
string

getDisplayGroup(string $name) : \Zend_Form_DisplayGroup | null

Return a display group

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Form_DisplayGroup \| null

getDisplayGroups() : array

Return all display groups

Returns

Type	Description
array

getElement(string $name) : \Zend_Form_Element | null

Retrieve a single element

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Form_Element \| null

getElements() : array

Retrieve all elements

Returns

Type	Description
array

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.

Returns

Type	Description
array

Details

Access: protected

getElementsBelongTo() : string | null

Get name of array elements belong to

Returns

Type	Description
string \| null

getEnctype() : string

Get encoding type

Returns

Type	Description
string

getErrorMessages() : array

Retrieve custom error messages

Returns

Type	Description
array

getErrors(string $name = null, $suppressArrayNotation = false) : array

Get error codes for all elements failing validation

Parameters

Name	Type	Description
$name	string
$suppressArrayNotation

Returns

Type	Description
array

getFullyQualifiedName() : string

Get fully qualified name

Places name as subitem of array and/or appends brackets.

Returns

Type	Description
string

getId() : string

Get element id

Returns

Type	Description
string

getLegend() : string

Get form legend

Returns

Type	Description
string

getMessages(string $name = null, bool $suppressArrayNotation = false) : array

Retrieve error messages from elements failing validations

The array keys are validation failure message identifiers, and the array values are the corresponding human-readable message strings.

If isValid() was never called or if the most recent isValid() call returned true, then this method returns an empty array.

Parameters

Name	Type	Description
$name	string
$suppressArrayNotation	bool

Returns

Type	Description
array

getMethod() : string

Retrieve form method

Returns

Type	Description
string

getName() : null | string

Get name attribute

Returns

Type	Description
null \| string

getOrder() : int | null

Get form order

Returns

Type	Description
int \| null

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.

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
\Zend_Loader_PluginLoader_Interface

getSubForm(string $name) : \Zend_Form | null

Retrieve a form subForm/subform

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Form \| null

getSubForms() : array

Retrieve all form subForms/subforms

Returns

Type	Description
array

getTranslator() : \Zend_Translate | null

Retrieve translator object

Returns

Type	Description
\Zend_Translate \| null

getUnfilteredValue(string $name) : mixed

Get unfiltered element value

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
mixed

getUnfilteredValues() : array

Retrieve all unfiltered element values

Returns

Type	Description
array

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.

Parameters

Name	Type	Description
$data	array
$suppressArrayNotation	bool

Returns

Type	Description
array

getValue(string $name) : mixed

Retrieve value for single element

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
mixed

getValues(bool $suppressArrayNotation = false) : array

Retrieve all form element values

Parameters

Name	Type	Description
$suppressArrayNotation	bool

Returns

Type	Description
array

getView() : \Zend_View_Interface | null

Retrieve view object

If none registered, attempts to pull from ViewRenderer.

Returns

Type	Description
\Zend_View_Interface \| null

hasDefaultTranslator() : boolean

static

Is there a default translation object set?

Returns

Type	Description
boolean

hasErrors() : bool

Are there errors in the form?

Returns

Type	Description
bool

hasTranslator() : bool

Does this form have its own specific translator?

Returns

Type	Description
bool

init() : void

Initialize form (used by extending classes)

isArray() : bool

Get flag indicating if elements belong to an array

Returns

Type	Description
bool

isErrors() : bool

Are there errors in the form?

Returns

Type	Description
bool

Details

Deprecated: since 1.11.1 - use hasErrors() instead

isValid(array $data) : boolean

Validate the form

If $value fails validation, then this method returns false, and getMessages() will return an array of messages that explain why the validation failed.

Parameters

Name	Type	Description
$data	array

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Validate_Exception	If validation of $value is impossible

isValidPartial(array $data) : boolean

Validate a partial form

Does not check for required flags.

Parameters

Name	Type	Description
$data	array

Returns

Type	Description
boolean

key() : string

Current element/subform/display group name

Returns

Type	Description
string

loadDefaultDecorators() : \Zend_Form

Load the default decorators

Returns

Type	Description
\Zend_Form

loadDefaultDecoratorsIsDisabled() : bool

Should we load the default decorators?

Returns

Type	Description
bool

markAsError() : \Zend_Form

Mark the element as being in a failed validation state

Returns

Type	Description
\Zend_Form

next() : void

Move pointer to next element/subform/display group

persistData() : void

populate(array $values) : \Zend_Form

Populate form

Proxies to setDefaults()

Parameters

Name	Type	Description
$values	array

Returns

Type	Description
\Zend_Form

processAjax(array $data) : string

Process submitted AJAX data

Checks if provided $data is valid, via isValidPartial(). If so, it returns JSON-encoded boolean true. If not, it returns JSON-encoded error messages (as returned by getMessages()).

Parameters

Name	Type	Description
$data	array

Returns

Type	Description
string	JSON-encoded boolean true or error messages

removeAttrib(string $key) : bool

Remove attribute

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
bool

removeDecorator(string $name) : bool

Remove a single decorator

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
bool

removeDisplayGroup(string $name) : boolean

Remove a display group by name

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
boolean

removeElement(string $name) : boolean

Remove element

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
boolean

removeFromIteration(string $name) : void

Remove an element from iteration

Parameters

Name	Type	Description
$name	string	Element/group/form name

removeSubForm(string $name) : boolean

Remove form subForm/subform

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
boolean

render(\Zend_View_Interface $view = null) : string

Render form

Parameters

Name	Type	Description
$view	\Zend_View_Interface

Returns

Type	Description
string

reset() : \Zend_Form

Reset values of form

Returns

Type	Description
\Zend_Form

rewind() : void

Move pointer to beginning of element/subform/display group loop

setAction(string $action) : \Zend_Form

Set form action

Parameters

Name	Type	Description
$action	string

Returns

Type	Description
\Zend_Form

setAttrib(string $key, mixed $value) : \Zend_Form

Set form attribute

Parameters

Name	Type	Description
$key	string
$value	mixed

Returns

Type	Description
\Zend_Form

setAttribs(array $attribs) : \Zend_Form

Set multiple form attributes at once

Overwrites any previously set attributes.

Parameters

Name	Type	Description
$attribs	array

Returns

Type	Description
\Zend_Form

setConfig(\Zend_Config $config) : \Zend_Form

Set form state from config object

Parameters

Name	Type	Description
$config	\Zend_Config

Returns

Type	Description
\Zend_Form

setDecorators(array $decorators) : \Zend_Form

Overwrite all decorators

Parameters

Name	Type	Description
$decorators	array

Returns

Type	Description
\Zend_Form

setDefault(string $name, mixed $value) : \Zend_Form

Set default value for an element

Parameters

Name	Type	Description
$name	string
$value	mixed

Returns

Type	Description
\Zend_Form

setDefaultDisplayGroupClass(string $class) : \Zend_Form

Set default display group class

Parameters

Name	Type	Description
$class	string

Returns

Type	Description
\Zend_Form

setDefaultTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : void

static

Set global default translator object

Parameters

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.

Parameters

Name	Type	Description
$defaults	array

Returns

Type	Description
\Zend_Form

setDescription(string $value) : \Zend_Form

Set form description

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Form

setDisableLoadDefaultDecorators(bool $flag) : \Zend_Form

Set flag to disable loading default decorators

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Form

setDisableTranslator(bool $flag) : \Zend_Form

Indicate whether or not translation should be disabled

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Form

setDisplayGroupDecorators(array $decorators) : \Zend_Form

Set all display group decorators as specified

Parameters

Name	Type	Description
$decorators	array

Returns

Type	Description
\Zend_Form

setDisplayGroups(array $groups) : \Zend_Form

Add multiple display groups (overwrites)

Parameters

Name	Type	Description
$groups	array

Returns

Type	Description
\Zend_Form

setElementDecorators(array $decorators, array | null $elements = null, bool $include = true) : \Zend_Form

Set all element decorators as specified

Parameters

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

Returns

Type	Description
\Zend_Form

setElementFilters(array $filters) : \Zend_Form

Set all elements' filters

Parameters

Name	Type	Description
$filters	array

Returns

Type	Description
\Zend_Form

setElements(array $elements) : \Zend_Form

Set form elements (overwrites existing elements)

Parameters

Name	Type	Description
$elements	array

Returns

Type	Description
\Zend_Form

setElementsBelongTo(string $array) : \Zend_Form

Set name of array elements belong to

Parameters

Name	Type	Description
$array	string

Returns

Type	Description
\Zend_Form

setEnctype(string $value) : \Zend_Form

Set encoding type

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Form

setErrorMessages(array $messages) : \Zend_Form

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

Parameters

Name	Type	Description
$messages	array

Returns

Type	Description
\Zend_Form

setErrors(array $messages) : \Zend_Form

Overwrite any previously set error messages and flag as failed validation

Parameters

Name	Type	Description
$messages	array

Returns

Type	Description
\Zend_Form

setIsArray(bool $flag) : \Zend_Form

Set flag indicating elements belong to array

Parameters

Name	Type	Description
$flag	bool	Value of flag

Returns

Type	Description
\Zend_Form

setLegend(string $value) : \Zend_Form

Set form legend

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Form

setMethod(string $method) : \Zend_Form

Set form method

Only values in $_methods() allowed

Parameters

Name	Type	Description
$method	string

Returns

Type	Description
\Zend_Form

Throws

Exception	Description
\Zend_Form_Exception

setName(string $name) : \Zend_Form

Set form name

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Form

setOptions(array $options) : \Zend_Form

Set form state from options array

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Form

setOrder(int $index) : \Zend_Form

Set form order

Parameters

Name	Type	Description
$index	int

Returns

Type	Description
\Zend_Form

setPluginLoader(\Zend_Loader_PluginLoader_Interface $loader, string $type = null) : \Zend_Form

Set plugin loaders for use with decorators and elements

Parameters

Name	Type	Description
$loader	\Zend_Loader_PluginLoader_Interface
$type	string	'decorator' or 'element'

Returns

Type	Description
\Zend_Form

Throws

Exception	Description
\Zend_Form_Exception	on invalid type

setSubFormDecorators(array $decorators) : \Zend_Form

Set all subform decorators as specified

Parameters

Name	Type	Description
$decorators	array

Returns

Type	Description
\Zend_Form

setSubForms(array $subForms) : \Zend_Form

Set multiple form subForms/subforms (overwrites)

Parameters

Name	Type	Description
$subForms	array

Returns

Type	Description
\Zend_Form

setTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : \Zend_Form

Set translator object

Parameters

Name	Type	Description
$translator	\Zend_Translate \| \Zend_Translate_Adapter \| null

Returns

Type	Description
\Zend_Form

setView(\Zend_View_Interface $view = null) : \Zend_Form

Set view object

Parameters

Name	Type	Description
$view	\Zend_View_Interface

Returns

Type	Description
\Zend_Form

translatorIsDisabled() : bool

Is translation disabled?

Returns

Type	Description
bool

valid() : bool

Determine if current element/subform/display group is valid

Returns

Type	Description
bool

Form.php

\Zend_Formjump to top

Constants

Properties

Methods

\Zend_Form
jump to top