Dojo/Form/SubForm.php

Show: PublicProtectedPrivateinherited
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 license@zend.com 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_Dojo  
Subpackage
Form  

\Zend_Dojo_Form_SubForm

Package: Zend\Dojo\Form
Dijit-enabled SubForm
Parent(s)
\Zend_Form_SubForm < \Zend_Form
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
\global\Zend_Form_SubForm  
Version
$Id: SubForm.php 24593 2012-01-05 20:35:02Z matthew $  

Constants

>VConstant  DECORATOR = 'DECORATOR'
Inherited_from
\Zend_Form::DECORATOR  
Inherited_from
\Zend_Form_SubForm::DECORATOR  
>VConstant  ELEMENT = 'ELEMENT'
Inherited_from
\Zend_Form::ELEMENT  
Inherited_from
\Zend_Form_SubForm::ELEMENT  
>VConstant  METHOD_DELETE = 'delete'
>VConstant  METHOD_GET = 'get'
Inherited_from
\Zend_Form::METHOD_GET  
Inherited_from
\Zend_Form_SubForm::METHOD_GET  
>VConstant  METHOD_POST = 'post'
Inherited_from
\Zend_Form::METHOD_POST  
Inherited_from
\Zend_Form_SubForm::METHOD_POST  
>VConstant  METHOD_PUT = 'put'
Inherited_from
\Zend_Form::METHOD_PUT  
Inherited_from
\Zend_Form_SubForm::METHOD_PUT  
>VConstant  ENCTYPE_URLENCODED = 'application/x-www-form-urlencoded'
>VConstant  ENCTYPE_MULTIPART = 'multipart/form-data'

Properties

>VPropertyprotectedarray $_attribs = array()
inherited
Form metadata and attributes
Inherited from: \Zend_Form::$$_attribs\Zend_Form_SubForm::$$_attribs
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form::$$_attribs  
Inherited_from
\Zend_Form_SubForm::$$_attribs  
>VPropertyprotectedarray $_decorators = array()
inherited
Decorators for rendering
Inherited from: \Zend_Form::$$_decorators\Zend_Form_SubForm::$$_decorators
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form::$$_decorators  
Inherited_from
\Zend_Form_SubForm::$$_decorators  
>VPropertyprotectedstring $_defaultDisplayGroupClass = 'Zend_Form_DisplayGroup'
Default value'Zend_Form_DisplayGroup'Details
Type
string
Inherited_from
\Zend_Form::$$_defaultDisplayGroupClass  
Inherited_from
\Zend_Form_SubForm::$$_defaultDisplayGroupClass  
>VPropertyprotectedstring $_description
inherited
Form description
Inherited from: \Zend_Form::$$_description\Zend_Form_SubForm::$$_description
Details
Type
string
Inherited_from
\Zend_Form::$$_description  
Inherited_from
\Zend_Form_SubForm::$$_description  
>VPropertyprotectedbool $_disableLoadDefaultDecorators = false
inherited
Should we disable loading the default decorators?
Inherited from: \Zend_Form::$$_disableLoadDefaultDecorators\Zend_Form_SubForm::$$_disableLoadDefaultDecorators
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form::$$_disableLoadDefaultDecorators  
Inherited_from
\Zend_Form_SubForm::$$_disableLoadDefaultDecorators  
>VPropertyprotectedarray $_displayGroupPrefixPaths = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form::$$_displayGroupPrefixPaths  
Inherited_from
\Zend_Form_SubForm::$$_displayGroupPrefixPaths  
>VPropertyprotectedarray $_displayGroups = array()
inherited
Groups of elements grouped for display purposes
Inherited from: \Zend_Form::$$_displayGroups\Zend_Form_SubForm::$$_displayGroups
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form::$$_displayGroups  
Inherited_from
\Zend_Form_SubForm::$$_displayGroups  
>VPropertyprotectedbool $_dojoViewPathRegistered = false
Has the dojo view helper path been registered?
Default valuefalseDetails
Type
bool
>VPropertyprotectednull|array $_elementDecorators
inherited
Global decorators to apply to all elements
Inherited from: \Zend_Form::$$_elementDecorators\Zend_Form_SubForm::$$_elementDecorators
Details
Type
null | array
Inherited_from
\Zend_Form::$$_elementDecorators  
Inherited_from
\Zend_Form_SubForm::$$_elementDecorators  
>VPropertyprotectedarray $_elementPrefixPaths = array()
inherited
Prefix paths to use when creating elements
Inherited from: \Zend_Form::$$_elementPrefixPaths\Zend_Form_SubForm::$$_elementPrefixPaths
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form::$$_elementPrefixPaths  
Inherited_from
\Zend_Form_SubForm::$$_elementPrefixPaths  
>VPropertyprotectedarray $_elements = array()
inherited
Form elements
Inherited from: \Zend_Form::$$_elements\Zend_Form_SubForm::$$_elements
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form::$$_elements  
Inherited_from
\Zend_Form_SubForm::$$_elements  
>VPropertyprotectedstring $_elementsBelongTo
inherited
Array to which elements belong (if any)
Inherited from: \Zend_Form::$$_elementsBelongTo\Zend_Form_SubForm::$$_elementsBelongTo
Details
Type
string
Inherited_from
\Zend_Form::$$_elementsBelongTo  
Inherited_from
\Zend_Form_SubForm::$$_elementsBelongTo  
>VPropertyprotectedarray $_errorMessages = array()
inherited
Custom form-level error messages
Inherited from: \Zend_Form::$$_errorMessages\Zend_Form_SubForm::$$_errorMessages
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form::$$_errorMessages  
Inherited_from
\Zend_Form_SubForm::$$_errorMessages  
>VPropertyprotectedbool $_errorsExist = false
inherited
Are there errors in the form?
Inherited from: \Zend_Form::$$_errorsExist\Zend_Form_SubForm::$$_errorsExist
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form::$$_errorsExist  
Inherited_from
\Zend_Form_SubForm::$$_errorsExist  
>VPropertyprotectedbool $_errorsForced = false
inherited
Has the form been manually flagged as an error?
Inherited from: \Zend_Form::$$_errorsForced\Zend_Form_SubForm::$$_errorsForced
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form::$$_errorsForced  
Inherited_from
\Zend_Form_SubForm::$$_errorsForced  
>VPropertyprotectedint|null $_formOrder
Details
Type
int | null
Inherited_from
\Zend_Form::$$_formOrder  
Inherited_from
\Zend_Form_SubForm::$$_formOrder  
>VPropertyprotectedbool $_isArray = true
inherited
Whether or not form elements are members of an array
Inherited from: \Zend_Form_SubForm::$$_isArray
Default valuetrueDetails
Type
bool
Inherited_from
\Zend_Form_SubForm::$$_isArray  
>VPropertyprotectedbool $_isRendered = false
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form::$$_isRendered  
Inherited_from
\Zend_Form_SubForm::$$_isRendered  
>VPropertyprotectedstring $_legend
inherited
Form legend
Inherited from: \Zend_Form::$$_legend\Zend_Form_SubForm::$$_legend
Details
Type
string
Inherited_from
\Zend_Form::$$_legend  
Inherited_from
\Zend_Form_SubForm::$$_legend  
>VPropertyprotectedarray $_loaders = array()
inherited
Plugin loaders
Inherited from: \Zend_Form::$$_loaders\Zend_Form_SubForm::$$_loaders
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form::$$_loaders  
Inherited_from
\Zend_Form_SubForm::$$_loaders  
>VPropertyprotectedarray $_methods = array('delete', 'get', 'post', 'put')
inherited
Allowed form methods
Inherited from: \Zend_Form::$$_methods\Zend_Form_SubForm::$$_methods
Default valuearray('delete', 'get', 'post', 'put')Details
Type
array
Inherited_from
\Zend_Form::$$_methods  
Inherited_from
\Zend_Form_SubForm::$$_methods  
>VPropertyprotectedarray $_order = array()
inherited
Order in which to display and iterate elements
Inherited from: \Zend_Form::$$_order\Zend_Form_SubForm::$$_order
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form::$$_order  
Inherited_from
\Zend_Form_SubForm::$$_order  
>VPropertyprotectedbool $_orderUpdated = false
inherited
Whether internal order has been updated or not
Inherited from: \Zend_Form::$$_orderUpdated\Zend_Form_SubForm::$$_orderUpdated
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form::$$_orderUpdated  
Inherited_from
\Zend_Form_SubForm::$$_orderUpdated  
>VPropertyprotectedarray $_subFormPrefixPaths = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form::$$_subFormPrefixPaths  
Inherited_from
\Zend_Form_SubForm::$$_subFormPrefixPaths  
>VPropertyprotectedarray $_subForms = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form::$$_subForms  
Inherited_from
\Zend_Form_SubForm::$$_subForms  
>VPropertyprotected\Zend_Translate $_translator
>VPropertyprotected\Zend_Translate $_translatorDefault
staticinherited
Global default translation adapter
Inherited from: \Zend_Form::$$_translatorDefault\Zend_Form_SubForm::$$_translatorDefault
>VPropertyprotectedbool $_translatorDisabled = false
inherited
is the translator disabled?
Inherited from: \Zend_Form::$$_translatorDisabled\Zend_Form_SubForm::$$_translatorDisabled
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form::$$_translatorDisabled  
Inherited_from
\Zend_Form_SubForm::$$_translatorDisabled  
>VPropertyprotected\Zend_View_Interface $_view
Details
Type
\Zend_View_Interface
Inherited_from
\Zend_Form::$$_view  
Inherited_from
\Zend_Form_SubForm::$$_view  

Methods

methodpublic__call(string $method, array $args) : string
inherited

Overloading: allow rendering specific decorators

Inherited from: \Zend_Form::__call()\Zend_Form_SubForm::__call()

Call renderDecoratorName() to render a specific decorator.

Parameters
NameTypeDescription
$methodstring
$argsarray
Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Form_Exceptionfor invalid decorator or invalid method call
methodpublic__clone() : void
inherited

Clone form object and all children

Inherited from: \Zend_Form::__clone()\Zend_Form_SubForm::__clone()
methodpublic__construct(array | \Zend_Config | null $options = null) : void

Constructor

Registers form view helper as decorator

Parameters
NameTypeDescription
$optionsarray | \Zend_Config | null
methodpublic__get(string $name) : \Zend_Form_Element | \Zend_Form | null
inherited

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

Inherited from: \Zend_Form::__get()\Zend_Form_SubForm::__get()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_Form_Element | \Zend_Form | null
methodpublic__isset(string $name) : boolean
inherited

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

Inherited from: \Zend_Form::__isset()\Zend_Form_SubForm::__isset()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
boolean
methodpublic__set(string $name, \Zend_Form_Element | \Zend_Form $value) : void
inherited

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

Inherited from: \Zend_Form::__set()\Zend_Form_SubForm::__set()
Parameters
NameTypeDescription
$namestring
$value\Zend_Form_Element | \Zend_Form
Throws
ExceptionDescription
\Zend_Form_Exceptionfor invalid $value
methodpublic__toString() : string
inherited

Serialize as string

Inherited from: \Zend_Form::__toString()\Zend_Form_SubForm::__toString()

Proxies to render().

Returns
TypeDescription
string
methodpublic__unset(string $name) : void
inherited

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

Inherited from: \Zend_Form::__unset()\Zend_Form_SubForm::__unset()
Parameters
NameTypeDescription
$namestring
methodprotected_addDisplayGroupObject(\Zend_Form_DisplayGroup $group, string | null $name = null) : \Zend_Form
inherited

Add a display group object (used with cloning)

Inherited from: \Zend_Form::_addDisplayGroupObject()\Zend_Form_SubForm::_addDisplayGroupObject()
Parameters
NameTypeDescription
$group\Zend_Form_DisplayGroup
$namestring | null
Returns
TypeDescription
\Zend_Form
methodprotected_array_replace_recursive(array $into) : void
inherited

This is a helper function until php 5.3 is widespreaded

Inherited from: \Zend_Form::_array_replace_recursive()\Zend_Form_SubForm::_array_replace_recursive()
Parameters
NameTypeDescription
$intoarray
Details
Access
protected  
methodprotected_attachToArray(mixed $value, string $arrayPath) : array
inherited

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

Inherited from: \Zend_Form::_attachToArray()\Zend_Form_SubForm::_attachToArray()
Parameters
NameTypeDescription
$valuemixed

The value to attach

$arrayPathstring

Given array path to convert and attach to.

Returns
TypeDescription
array
methodprotected_dissolveArrayUnsetKey(array $array, string | null $arrayPath, string $key) : array
inherited

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

Inherited from: \Zend_Form::_dissolveArrayUnsetKey()\Zend_Form_SubForm::_dissolveArrayUnsetKey()
Parameters
NameTypeDescription
$arrayarray
$arrayPathstring | null
$keystring
Returns
TypeDescription
array
methodprotected_dissolveArrayValue(array $value, string $arrayPath) : string
inherited

Extract the value by walking the array using given array path.

Inherited from: \Zend_Form::_dissolveArrayValue()\Zend_Form_SubForm::_dissolveArrayValue()

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

Parameters
NameTypeDescription
$valuearray

Array to walk

$arrayPathstring

Array notation path of the part to extract

Returns
TypeDescription
string
methodprotected_getArrayName(string $value) : string
inherited

Determine array key name from given value

Inherited from: \Zend_Form::_getArrayName()\Zend_Form_SubForm::_getArrayName()

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

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
string
methodprotected_getDecorator(string $name, null | array $options) : \Zend_Form_Decorator_Interface
inherited

Instantiate a decorator based on class name or class name fragment

Inherited from: \Zend_Form::_getDecorator()\Zend_Form_SubForm::_getDecorator()
Parameters
NameTypeDescription
$namestring
$optionsnull | array
Returns
TypeDescription
\Zend_Form_Decorator_Interface
methodprotected_getErrorMessages() : array
inherited

Retrieve optionally translated custom error messages

Inherited from: \Zend_Form::_getErrorMessages()\Zend_Form_SubForm::_getErrorMessages()
Returns
TypeDescription
array
methodprotected_getIsRendered() : void
inherited

Get the value of $_isRendered member

Inherited from: \Zend_Form::_getIsRendered()\Zend_Form_SubForm::_getIsRendered()
methodprotected_loadDecorator(array $decorator, mixed $name) : \Zend_Form_Decorator_Interface
inherited

Lazy-load a decorator

Inherited from: \Zend_Form::_loadDecorator()\Zend_Form_SubForm::_loadDecorator()
Parameters
NameTypeDescription
$decoratorarray

Decorator type and options

$namemixed

Decorator name or alias

Returns
TypeDescription
\Zend_Form_Decorator_Interface
methodprotected_setElementsBelongTo(string $name = null) : void
inherited

Set array to which elements belong

Inherited from: \Zend_Form::_setElementsBelongTo()\Zend_Form_SubForm::_setElementsBelongTo()
Parameters
NameTypeDescription
$namestring

Element name

methodprotected_setIsRendered() : void
inherited

When calling renderFormElements or render this method is used to set $_isRendered member to prevent repeatedly merging belongsTo setting

Inherited from: \Zend_Form::_setIsRendered()\Zend_Form_SubForm::_setIsRendered()
methodprotected_sort() : void
inherited

Sort items according to their order

Inherited from: \Zend_Form::_sort()\Zend_Form_SubForm::_sort()
methodpublicaddAttribs(array $attribs) : \Zend_Form
inherited

Add multiple form attributes at once

Inherited from: \Zend_Form::addAttribs()\Zend_Form_SubForm::addAttribs()
Parameters
NameTypeDescription
$attribsarray
Returns
TypeDescription
\Zend_Form
methodpublicaddDecorator(string | \Zend_Form_Decorator_Interface $decorator, array | \Zend_Config $options = null) : \Zend_Form
inherited

Add a decorator for rendering the element

Inherited from: \Zend_Form::addDecorator()\Zend_Form_SubForm::addDecorator()
Parameters
NameTypeDescription
$decoratorstring | \Zend_Form_Decorator_Interface
$optionsarray | \Zend_Config

Options with which to initialize decorator

Returns
TypeDescription
\Zend_Form
methodpublicaddDecorators(array $decorators) : \Zend_Form
inherited

Add many decorators at once

Inherited from: \Zend_Form::addDecorators()\Zend_Form_SubForm::addDecorators()
Parameters
NameTypeDescription
$decoratorsarray
Returns
TypeDescription
\Zend_Form
methodpublicaddDisplayGroup(array $elements, string $name, array | \Zend_Config $options = null) : \Zend_Form
inherited

Add a display group

Inherited from: \Zend_Form::addDisplayGroup()\Zend_Form_SubForm::addDisplayGroup()

Groups named elements for display purposes.

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

Parameters
NameTypeDescription
$elementsarray
$namestring
$optionsarray | \Zend_Config
Returns
TypeDescription
\Zend_Form
Throws
ExceptionDescription
\Zend_Form_Exceptionif no valid elements provided
methodpublicaddDisplayGroupPrefixPath(string $prefix, string $path) : \Zend_Form
inherited

Add prefix path for all display groups

Inherited from: \Zend_Form::addDisplayGroupPrefixPath()\Zend_Form_SubForm::addDisplayGroupPrefixPath()
Parameters
NameTypeDescription
$prefixstring
$pathstring
Returns
TypeDescription
\Zend_Form
methodpublicaddDisplayGroupPrefixPaths(array $spec) : \Zend_Form
inherited

Add multiple display group prefix paths at once

Inherited from: \Zend_Form::addDisplayGroupPrefixPaths()\Zend_Form_SubForm::addDisplayGroupPrefixPaths()
Parameters
NameTypeDescription
$specarray
Returns
TypeDescription
\Zend_Form
methodpublicaddDisplayGroups(array $groups) : \Zend_Form
inherited

Add multiple display groups at once

Inherited from: \Zend_Form::addDisplayGroups()\Zend_Form_SubForm::addDisplayGroups()
Parameters
NameTypeDescription
$groupsarray
Returns
TypeDescription
\Zend_Form
methodpublicaddElement(string | \Zend_Form_Element $element, string $name = null, array | \Zend_Config $options = null) : \Zend_Form
inherited

Add a new element

Inherited from: \Zend_Form::addElement()\Zend_Form_SubForm::addElement()

$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
NameTypeDescription
$elementstring | \Zend_Form_Element
$namestring
$optionsarray | \Zend_Config
Returns
TypeDescription
\Zend_Form
Throws
ExceptionDescription
\Zend_Form_Exceptionon invalid element
methodpublicaddElementPrefixPath(string $prefix, string $path, string $type = null) : \Zend_Form
inherited

Add prefix path for all elements

Inherited from: \Zend_Form::addElementPrefixPath()\Zend_Form_SubForm::addElementPrefixPath()
Parameters
NameTypeDescription
$prefixstring
$pathstring
$typestring
Returns
TypeDescription
\Zend_Form
methodpublicaddElementPrefixPaths(array $spec) : \Zend_Form
inherited

Add prefix paths for all elements

Inherited from: \Zend_Form::addElementPrefixPaths()\Zend_Form_SubForm::addElementPrefixPaths()
Parameters
NameTypeDescription
$specarray
Returns
TypeDescription
\Zend_Form
methodpublicaddElements(array $elements) : \Zend_Form
inherited

Add multiple elements at once

Inherited from: \Zend_Form::addElements()\Zend_Form_SubForm::addElements()
Parameters
NameTypeDescription
$elementsarray
Returns
TypeDescription
\Zend_Form
methodpublicaddError(string $message) : \Zend_Form
inherited

Add an error message and mark element as failed validation

Inherited from: \Zend_Form::addError()\Zend_Form_SubForm::addError()
Parameters
NameTypeDescription
$messagestring
Returns
TypeDescription
\Zend_Form
methodpublicaddErrorMessage(string $message) : \Zend_Form
inherited

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

Inherited from: \Zend_Form::addErrorMessage()\Zend_Form_SubForm::addErrorMessage()
Parameters
NameTypeDescription
$messagestring
Returns
TypeDescription
\Zend_Form
methodpublicaddErrorMessages(array $messages) : \Zend_Form
inherited

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

Inherited from: \Zend_Form::addErrorMessages()\Zend_Form_SubForm::addErrorMessages()
Parameters
NameTypeDescription
$messagesarray
Returns
TypeDescription
\Zend_Form
methodpublicaddErrors(array $messages) : \Zend_Form
inherited

Add multiple error messages and flag element as failed validation

Inherited from: \Zend_Form::addErrors()\Zend_Form_SubForm::addErrors()
Parameters
NameTypeDescription
$messagesarray
Returns
TypeDescription
\Zend_Form
methodpublicaddPrefixPath(string $prefix, string $path, string $type = null) : \Zend_Form
inherited

Add prefix path for plugin loader

Inherited from: \Zend_Form::addPrefixPath()\Zend_Form_SubForm::addPrefixPath()

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
NameTypeDescription
$prefixstring
$pathstring
$typestring
Returns
TypeDescription
\Zend_Form
Throws
ExceptionDescription
\Zend_Form_Exceptionfor invalid type
methodpublicaddPrefixPaths(array $spec) : \Zend_Form
inherited

Add many prefix paths at once

Inherited from: \Zend_Form::addPrefixPaths()\Zend_Form_SubForm::addPrefixPaths()
Parameters
NameTypeDescription
$specarray
Returns
TypeDescription
\Zend_Form
methodpublicaddSubForm(\Zend_Form $form, string $name, int $order = null) : \Zend_Form
inherited

Add a form group/subform

Inherited from: \Zend_Form::addSubForm()\Zend_Form_SubForm::addSubForm()
Parameters
NameTypeDescription
$form\Zend_Form
$namestring
$orderint
Returns
TypeDescription
\Zend_Form
methodpublicaddSubForms(array $subForms) : \Zend_Form
inherited

Add multiple form subForms/subforms at once

Inherited from: \Zend_Form::addSubForms()\Zend_Form_SubForm::addSubForms()
Parameters
NameTypeDescription
$subFormsarray
Returns
TypeDescription
\Zend_Form
methodpublicclearAttribs() : \Zend_Form
inherited

Clear all form attributes

Inherited from: \Zend_Form::clearAttribs()\Zend_Form_SubForm::clearAttribs()
Returns
TypeDescription
\Zend_Form
methodpublicclearDecorators() : \Zend_Form
inherited

Clear all decorators

Inherited from: \Zend_Form::clearDecorators()\Zend_Form_SubForm::clearDecorators()
Returns
TypeDescription
\Zend_Form
methodpublicclearDisplayGroups() : \Zend_Form
inherited

Remove all display groups

Inherited from: \Zend_Form::clearDisplayGroups()\Zend_Form_SubForm::clearDisplayGroups()
Returns
TypeDescription
\Zend_Form
methodpublicclearElements() : \Zend_Form
inherited

Remove all form elements

Inherited from: \Zend_Form::clearElements()\Zend_Form_SubForm::clearElements()
Returns
TypeDescription
\Zend_Form
methodpublicclearErrorMessages() : \Zend_Form
inherited

Clear custom error messages stack

Inherited from: \Zend_Form::clearErrorMessages()\Zend_Form_SubForm::clearErrorMessages()
Returns
TypeDescription
\Zend_Form
methodpublicclearSubForms() : \Zend_Form
inherited

Remove all form subForms/subforms

Inherited from: \Zend_Form::clearSubForms()\Zend_Form_SubForm::clearSubForms()
Returns
TypeDescription
\Zend_Form
methodpubliccount() : int
inherited

Count of elements/subforms that are iterable

Inherited from: \Zend_Form::count()\Zend_Form_SubForm::count()
Returns
TypeDescription
int
methodpubliccreateElement(string $type, string $name, array | \Zend_Config $options = null) : \Zend_Form_Element
inherited

Create an element

Inherited from: \Zend_Form::createElement()\Zend_Form_SubForm::createElement()

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
NameTypeDescription
$typestring
$namestring
$optionsarray | \Zend_Config
Returns
TypeDescription
\Zend_Form_Element
methodpubliccurrent() : \Zend_Form_Element | \Zend_Form_DisplayGroup | \Zend_Form
inherited

Current element/subform/display group

Inherited from: \Zend_Form::current()\Zend_Form_SubForm::current()
methodpublicfilterName(string $value, bool $allowBrackets = false) : string
inherited

Filter a name to only allow valid variable characters

Inherited from: \Zend_Form::filterName()\Zend_Form_SubForm::filterName()
Parameters
NameTypeDescription
$valuestring
$allowBracketsbool
Returns
TypeDescription
string
methodpublicgetAction() : string
inherited

Get form action

Inherited from: \Zend_Form::getAction()\Zend_Form_SubForm::getAction()

Sets default to '' if not set.

Returns
TypeDescription
string
methodpublicgetAttrib(string $key) : mixed
inherited

Retrieve a single form attribute

Inherited from: \Zend_Form::getAttrib()\Zend_Form_SubForm::getAttrib()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublicgetAttribs() : array
inherited

Retrieve all form attributes/metadata

Inherited from: \Zend_Form::getAttribs()\Zend_Form_SubForm::getAttribs()
Returns
TypeDescription
array
methodpublicgetCustomMessages() : array
inherited

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

Inherited from: \Zend_Form::getCustomMessages()\Zend_Form_SubForm::getCustomMessages()
Returns
TypeDescription
array
methodpublicgetDecorator(string $name) : false | \Zend_Form_Decorator_Abstract
inherited

Retrieve a registered decorator

Inherited from: \Zend_Form::getDecorator()\Zend_Form_SubForm::getDecorator()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
false | \Zend_Form_Decorator_Abstract
methodpublicgetDecorators() : array
inherited

Retrieve all decorators

Inherited from: \Zend_Form::getDecorators()\Zend_Form_SubForm::getDecorators()
Returns
TypeDescription
array
methodpublicgetDefaultDisplayGroupClass() : string
inherited

Retrieve default display group class

Inherited from: \Zend_Form::getDefaultDisplayGroupClass()\Zend_Form_SubForm::getDefaultDisplayGroupClass()
Returns
TypeDescription
string
methodpublicgetDefaultTranslator() : null | \Zend_Translate
staticinherited

Get global default translator object

Inherited from: \Zend_Form::getDefaultTranslator()\Zend_Form_SubForm::getDefaultTranslator()
Returns
TypeDescription
null | \Zend_Translate
methodpublicgetDescription() : string
inherited

Retrieve form description

Inherited from: \Zend_Form::getDescription()\Zend_Form_SubForm::getDescription()
Returns
TypeDescription
string
methodpublicgetDisplayGroup(string $name) : \Zend_Form_DisplayGroup | null
inherited

Return a display group

Inherited from: \Zend_Form::getDisplayGroup()\Zend_Form_SubForm::getDisplayGroup()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_Form_DisplayGroup | null
methodpublicgetDisplayGroups() : array
inherited

Return all display groups

Inherited from: \Zend_Form::getDisplayGroups()\Zend_Form_SubForm::getDisplayGroups()
Returns
TypeDescription
array
methodpublicgetElement(string $name) : \Zend_Form_Element | null
inherited

Retrieve a single element

Inherited from: \Zend_Form::getElement()\Zend_Form_SubForm::getElement()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_Form_Element | null
methodpublicgetElements() : array
inherited

Retrieve all elements

Inherited from: \Zend_Form::getElements()\Zend_Form_SubForm::getElements()
Returns
TypeDescription
array
methodpublicgetElementsAndSubFormsOrdered() : array
inherited

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

Inherited from: \Zend_Form::getElementsAndSubFormsOrdered()\Zend_Form_SubForm::getElementsAndSubFormsOrdered()

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
TypeDescription
array
Details
Access
protected  
methodpublicgetElementsBelongTo() : string | null
inherited

Get name of array elements belong to

Inherited from: \Zend_Form::getElementsBelongTo()\Zend_Form_SubForm::getElementsBelongTo()
Returns
TypeDescription
string | null
methodpublicgetEnctype() : string
inherited

Get encoding type

Inherited from: \Zend_Form::getEnctype()\Zend_Form_SubForm::getEnctype()
Returns
TypeDescription
string
methodpublicgetErrorMessages() : array
inherited

Retrieve custom error messages

Inherited from: \Zend_Form::getErrorMessages()\Zend_Form_SubForm::getErrorMessages()
Returns
TypeDescription
array
methodpublicgetErrors(string $name = null,  $suppressArrayNotation = false) : array
inherited

Get error codes for all elements failing validation

Inherited from: \Zend_Form::getErrors()\Zend_Form_SubForm::getErrors()
Parameters
NameTypeDescription
$namestring
$suppressArrayNotation
Returns
TypeDescription
array
methodpublicgetFullyQualifiedName() : string

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

Returns
TypeDescription
string
methodpublicgetId() : string
inherited

Get element id

Inherited from: \Zend_Form::getId()\Zend_Form_SubForm::getId()
Returns
TypeDescription
string
methodpublicgetLegend() : string
inherited

Get form legend

Inherited from: \Zend_Form::getLegend()\Zend_Form_SubForm::getLegend()
Returns
TypeDescription
string
methodpublicgetMessages(string $name = null, bool $suppressArrayNotation = false) : array
inherited

Retrieve error messages from elements failing validations

Inherited from: \Zend_Form::getMessages()\Zend_Form_SubForm::getMessages()

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
NameTypeDescription
$namestring
$suppressArrayNotationbool
Returns
TypeDescription
array
methodpublicgetMethod() : string
inherited

Retrieve form method

Inherited from: \Zend_Form::getMethod()\Zend_Form_SubForm::getMethod()
Returns
TypeDescription
string
methodpublicgetName() : null | string
inherited

Get name attribute

Inherited from: \Zend_Form::getName()\Zend_Form_SubForm::getName()
Returns
TypeDescription
null | string
methodpublicgetOrder() : int | null
inherited

Get form order

Inherited from: \Zend_Form::getOrder()\Zend_Form_SubForm::getOrder()
Returns
TypeDescription
int | null
methodpublicgetPluginLoader(string $type = null) : \Zend_Loader_PluginLoader_Interface
inherited

Retrieve plugin loader for given type

Inherited from: \Zend_Form::getPluginLoader()\Zend_Form_SubForm::getPluginLoader()

$type may be one of: - decorator - element

If a plugin loader does not exist for the given type, defaults are created.

Parameters
NameTypeDescription
$typestring
Returns
TypeDescription
\Zend_Loader_PluginLoader_Interface
methodpublicgetSubForm(string $name) : \Zend_Form | null
inherited

Retrieve a form subForm/subform

Inherited from: \Zend_Form::getSubForm()\Zend_Form_SubForm::getSubForm()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_Form | null
methodpublicgetSubForms() : array
inherited

Retrieve all form subForms/subforms

Inherited from: \Zend_Form::getSubForms()\Zend_Form_SubForm::getSubForms()
Returns
TypeDescription
array
methodpublicgetTranslator() : \Zend_Translate | null
inherited

Retrieve translator object

Inherited from: \Zend_Form::getTranslator()\Zend_Form_SubForm::getTranslator()
Returns
TypeDescription
\Zend_Translate | null
methodpublicgetUnfilteredValue(string $name) : mixed
inherited

Get unfiltered element value

Inherited from: \Zend_Form::getUnfilteredValue()\Zend_Form_SubForm::getUnfilteredValue()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
mixed
methodpublicgetUnfilteredValues() : array
inherited

Retrieve all unfiltered element values

Inherited from: \Zend_Form::getUnfilteredValues()\Zend_Form_SubForm::getUnfilteredValues()
Returns
TypeDescription
array
methodpublicgetValidValues(array $data, bool $suppressArrayNotation = false) : array
inherited

Returns only the valid values from the given form input.

Inherited from: \Zend_Form::getValidValues()\Zend_Form_SubForm::getValidValues()

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
NameTypeDescription
$dataarray
$suppressArrayNotationbool
Returns
TypeDescription
array
methodpublicgetValue(string $name) : mixed
inherited

Retrieve value for single element

Inherited from: \Zend_Form::getValue()\Zend_Form_SubForm::getValue()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
mixed
methodpublicgetValues(bool $suppressArrayNotation = false) : array
inherited

Retrieve all form element values

Inherited from: \Zend_Form::getValues()\Zend_Form_SubForm::getValues()
Parameters
NameTypeDescription
$suppressArrayNotationbool
Returns
TypeDescription
array
methodpublicgetView() : \Zend_View_Interface

Get view

If none registered, attempts to pull from ViewRenderer.

Returns
TypeDescription
\Zend_View_Interface
methodpublichasDefaultTranslator() : boolean
staticinherited

Is there a default translation object set?

Inherited from: \Zend_Form::hasDefaultTranslator()\Zend_Form_SubForm::hasDefaultTranslator()
Returns
TypeDescription
boolean
methodpublichasErrors() : bool
inherited

Are there errors in the form?

Inherited from: \Zend_Form::hasErrors()\Zend_Form_SubForm::hasErrors()
Returns
TypeDescription
bool
methodpublichasTranslator() : bool
inherited

Does this form have its own specific translator?

Inherited from: \Zend_Form::hasTranslator()\Zend_Form_SubForm::hasTranslator()
Returns
TypeDescription
bool
methodpublicinit() : void
inherited

Initialize form (used by extending classes)

Inherited from: \Zend_Form::init()\Zend_Form_SubForm::init()
methodpublicisArray() : bool
inherited

Get flag indicating if elements belong to an array

Inherited from: \Zend_Form::isArray()\Zend_Form_SubForm::isArray()
Returns
TypeDescription
bool
methodpublicisErrors() : bool
inherited

Are there errors in the form?

Inherited from: \Zend_Form::isErrors()\Zend_Form_SubForm::isErrors()
Returns
TypeDescription
bool
methodpublicisValid(array $data) : boolean
inherited

Validate the form

Inherited from: \Zend_Form::isValid()\Zend_Form_SubForm::isValid()

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

Parameters
NameTypeDescription
$dataarray
Returns
TypeDescription
boolean
Throws
ExceptionDescription
\Zend_Validate_ExceptionIf validation of $value is impossible
methodpublicisValidPartial(array $data) : boolean
inherited

Validate a partial form

Inherited from: \Zend_Form::isValidPartial()\Zend_Form_SubForm::isValidPartial()

Does not check for required flags.

Parameters
NameTypeDescription
$dataarray
Returns
TypeDescription
boolean
methodpublickey() : string
inherited

Current element/subform/display group name

Inherited from: \Zend_Form::key()\Zend_Form_SubForm::key()
Returns
TypeDescription
string
methodpublicloadDefaultDecorators() : void

Load the default decorators

methodpublicloadDefaultDecoratorsIsDisabled() : bool
Returns
TypeDescription
bool
methodpublicmarkAsError() : \Zend_Form
inherited

Mark the element as being in a failed validation state

Inherited from: \Zend_Form::markAsError()\Zend_Form_SubForm::markAsError()
Returns
TypeDescription
\Zend_Form
methodpublicnext() : void
inherited

Move pointer to next element/subform/display group

Inherited from: \Zend_Form::next()\Zend_Form_SubForm::next()
methodpublicpersistData() : void
methodpublicpopulate(array $values) : \Zend_Form
inherited

Populate form

Inherited from: \Zend_Form::populate()\Zend_Form_SubForm::populate()

Proxies to setDefaults()

Parameters
NameTypeDescription
$valuesarray
Returns
TypeDescription
\Zend_Form
methodpublicprocessAjax(array $data) : string
inherited

Process submitted AJAX data

Inherited from: \Zend_Form::processAjax()\Zend_Form_SubForm::processAjax()

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
NameTypeDescription
$dataarray
Returns
TypeDescription
stringJSON-encoded boolean true or error messages
methodpublicremoveAttrib(string $key) : bool
inherited

Remove attribute

Inherited from: \Zend_Form::removeAttrib()\Zend_Form_SubForm::removeAttrib()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
bool
methodpublicremoveDecorator(string $name) : bool
inherited

Remove a single decorator

Inherited from: \Zend_Form::removeDecorator()\Zend_Form_SubForm::removeDecorator()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
bool
methodpublicremoveDisplayGroup(string $name) : boolean
inherited

Remove a display group by name

Inherited from: \Zend_Form::removeDisplayGroup()\Zend_Form_SubForm::removeDisplayGroup()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
boolean
methodpublicremoveElement(string $name) : boolean
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
boolean
methodpublicremoveFromIteration(string $name) : void
inherited

Remove an element from iteration

Inherited from: \Zend_Form::removeFromIteration()\Zend_Form_SubForm::removeFromIteration()
Parameters
NameTypeDescription
$namestring

Element/group/form name

methodpublicremoveSubForm(string $name) : boolean
inherited

Remove form subForm/subform

Inherited from: \Zend_Form::removeSubForm()\Zend_Form_SubForm::removeSubForm()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
boolean
methodpublicrender(\Zend_View_Interface $view = null) : string
inherited

Render form

Inherited from: \Zend_Form::render()\Zend_Form_SubForm::render()
Parameters
NameTypeDescription
$view\Zend_View_Interface
Returns
TypeDescription
string
methodpublicreset() : \Zend_Form
inherited

Reset values of form

Inherited from: \Zend_Form::reset()\Zend_Form_SubForm::reset()
Returns
TypeDescription
\Zend_Form
methodpublicrewind() : void
inherited

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

Inherited from: \Zend_Form::rewind()\Zend_Form_SubForm::rewind()
methodpublicsetAction(string $action) : \Zend_Form
inherited

Set form action

Inherited from: \Zend_Form::setAction()\Zend_Form_SubForm::setAction()
Parameters
NameTypeDescription
$actionstring
Returns
TypeDescription
\Zend_Form
methodpublicsetAttrib(string $key, mixed $value) : \Zend_Form
inherited

Set form attribute

Inherited from: \Zend_Form::setAttrib()\Zend_Form_SubForm::setAttrib()
Parameters
NameTypeDescription
$keystring
$valuemixed
Returns
TypeDescription
\Zend_Form
methodpublicsetAttribs(array $attribs) : \Zend_Form
inherited

Set multiple form attributes at once

Inherited from: \Zend_Form::setAttribs()\Zend_Form_SubForm::setAttribs()

Overwrites any previously set attributes.

Parameters
NameTypeDescription
$attribsarray
Returns
TypeDescription
\Zend_Form
methodpublicsetConfig(\Zend_Config $config) : \Zend_Form
inherited

Set form state from config object

Inherited from: \Zend_Form::setConfig()\Zend_Form_SubForm::setConfig()
Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_Form
methodpublicsetDecorators(array $decorators) : \Zend_Form
inherited

Overwrite all decorators

Inherited from: \Zend_Form::setDecorators()\Zend_Form_SubForm::setDecorators()
Parameters
NameTypeDescription
$decoratorsarray
Returns
TypeDescription
\Zend_Form
methodpublicsetDefault(string $name, mixed $value) : \Zend_Form
inherited

Set default value for an element

Inherited from: \Zend_Form::setDefault()\Zend_Form_SubForm::setDefault()
Parameters
NameTypeDescription
$namestring
$valuemixed
Returns
TypeDescription
\Zend_Form
methodpublicsetDefaultDisplayGroupClass(string $class) : \Zend_Form
Parameters
NameTypeDescription
$classstring
Returns
TypeDescription
\Zend_Form
methodpublicsetDefaultTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : void
staticinherited

Set global default translator object

Inherited from: \Zend_Form::setDefaultTranslator()\Zend_Form_SubForm::setDefaultTranslator()
Parameters
NameTypeDescription
$translator\Zend_Translate | \Zend_Translate_Adapter | null
methodpublicsetDefaults(array $defaults) : \Zend_Form
inherited

Set default values for elements

Inherited from: \Zend_Form::setDefaults()\Zend_Form_SubForm::setDefaults()

Sets values for all elements specified in the array of $defaults.

Parameters
NameTypeDescription
$defaultsarray
Returns
TypeDescription
\Zend_Form
methodpublicsetDescription(string $value) : \Zend_Form
inherited

Set form description

Inherited from: \Zend_Form::setDescription()\Zend_Form_SubForm::setDescription()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Form
methodpublicsetDisableLoadDefaultDecorators(bool $flag) : \Zend_Form
inherited

Set flag to disable loading default decorators

Inherited from: \Zend_Form::setDisableLoadDefaultDecorators()\Zend_Form_SubForm::setDisableLoadDefaultDecorators()
Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Form
methodpublicsetDisableTranslator(bool $flag) : \Zend_Form
inherited

Indicate whether or not translation should be disabled

Inherited from: \Zend_Form::setDisableTranslator()\Zend_Form_SubForm::setDisableTranslator()
Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Form
methodpublicsetDisplayGroupDecorators(array $decorators) : \Zend_Form
inherited

Set all display group decorators as specified

Inherited from: \Zend_Form::setDisplayGroupDecorators()\Zend_Form_SubForm::setDisplayGroupDecorators()
Parameters
NameTypeDescription
$decoratorsarray
Returns
TypeDescription
\Zend_Form
methodpublicsetDisplayGroups(array $groups) : \Zend_Form
inherited

Add multiple display groups (overwrites)

Inherited from: \Zend_Form::setDisplayGroups()\Zend_Form_SubForm::setDisplayGroups()
Parameters
NameTypeDescription
$groupsarray
Returns
TypeDescription
\Zend_Form
methodpublicsetElementDecorators(array $decorators, array | null $elements = null, bool $include = true) : \Zend_Form
inherited

Set all element decorators as specified

Inherited from: \Zend_Form::setElementDecorators()\Zend_Form_SubForm::setElementDecorators()
Parameters
NameTypeDescription
$decoratorsarray
$elementsarray | null

Specific elements to decorate or exclude from decoration

$includebool

Whether $elements is an inclusion or exclusion list

Returns
TypeDescription
\Zend_Form
methodpublicsetElementFilters(array $filters) : \Zend_Form
inherited

Set all elements' filters

Inherited from: \Zend_Form::setElementFilters()\Zend_Form_SubForm::setElementFilters()
Parameters
NameTypeDescription
$filtersarray
Returns
TypeDescription
\Zend_Form
methodpublicsetElements(array $elements) : \Zend_Form
inherited

Set form elements (overwrites existing elements)

Inherited from: \Zend_Form::setElements()\Zend_Form_SubForm::setElements()
Parameters
NameTypeDescription
$elementsarray
Returns
TypeDescription
\Zend_Form
methodpublicsetElementsBelongTo(string $array) : \Zend_Form
inherited

Set name of array elements belong to

Inherited from: \Zend_Form::setElementsBelongTo()\Zend_Form_SubForm::setElementsBelongTo()
Parameters
NameTypeDescription
$arraystring
Returns
TypeDescription
\Zend_Form
methodpublicsetEnctype(string $value) : \Zend_Form
inherited

Set encoding type

Inherited from: \Zend_Form::setEnctype()\Zend_Form_SubForm::setEnctype()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Form
methodpublicsetErrorMessages(array $messages) : \Zend_Form
inherited

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

Inherited from: \Zend_Form::setErrorMessages()\Zend_Form_SubForm::setErrorMessages()
Parameters
NameTypeDescription
$messagesarray
Returns
TypeDescription
\Zend_Form
methodpublicsetErrors(array $messages) : \Zend_Form
inherited

Overwrite any previously set error messages and flag as failed validation

Inherited from: \Zend_Form::setErrors()\Zend_Form_SubForm::setErrors()
Parameters
NameTypeDescription
$messagesarray
Returns
TypeDescription
\Zend_Form
methodpublicsetIsArray(bool $flag) : \Zend_Form
inherited

Set flag indicating elements belong to array

Inherited from: \Zend_Form::setIsArray()\Zend_Form_SubForm::setIsArray()
Parameters
NameTypeDescription
$flagbool

Value of flag

Returns
TypeDescription
\Zend_Form
methodpublicsetLegend(string $value) : \Zend_Form
inherited

Set form legend

Inherited from: \Zend_Form::setLegend()\Zend_Form_SubForm::setLegend()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Form
methodpublicsetMethod(string $method) : \Zend_Form
inherited

Set form method

Inherited from: \Zend_Form::setMethod()\Zend_Form_SubForm::setMethod()

Only values in $_methods() allowed

Parameters
NameTypeDescription
$methodstring
Returns
TypeDescription
\Zend_Form
Throws
ExceptionDescription
\Zend_Form_Exception
methodpublicsetName(string $name) : \Zend_Form
inherited

Set form name

Inherited from: \Zend_Form::setName()\Zend_Form_SubForm::setName()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_Form
methodpublicsetOptions(array $options) : \Zend_Form
inherited

Set form state from options array

Inherited from: \Zend_Form::setOptions()\Zend_Form_SubForm::setOptions()
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Form
methodpublicsetOrder(int $index) : \Zend_Form
inherited

Set form order

Inherited from: \Zend_Form::setOrder()\Zend_Form_SubForm::setOrder()
Parameters
NameTypeDescription
$indexint
Returns
TypeDescription
\Zend_Form
methodpublicsetPluginLoader(\Zend_Loader_PluginLoader_Interface $loader, string $type = null) : \Zend_Form
inherited

Set plugin loaders for use with decorators and elements

Inherited from: \Zend_Form::setPluginLoader()\Zend_Form_SubForm::setPluginLoader()
Parameters
NameTypeDescription
$loader\Zend_Loader_PluginLoader_Interface
$typestring

'decorator' or 'element'

Returns
TypeDescription
\Zend_Form
Throws
ExceptionDescription
\Zend_Form_Exceptionon invalid type
methodpublicsetSubFormDecorators(array $decorators) : \Zend_Form
inherited

Set all subform decorators as specified

Inherited from: \Zend_Form::setSubFormDecorators()\Zend_Form_SubForm::setSubFormDecorators()
Parameters
NameTypeDescription
$decoratorsarray
Returns
TypeDescription
\Zend_Form
methodpublicsetSubForms(array $subForms) : \Zend_Form
inherited

Set multiple form subForms/subforms (overwrites)

Inherited from: \Zend_Form::setSubForms()\Zend_Form_SubForm::setSubForms()
Parameters
NameTypeDescription
$subFormsarray
Returns
TypeDescription
\Zend_Form
methodpublicsetTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : \Zend_Form
inherited

Set translator object

Inherited from: \Zend_Form::setTranslator()\Zend_Form_SubForm::setTranslator()
Parameters
NameTypeDescription
$translator\Zend_Translate | \Zend_Translate_Adapter | null
Returns
TypeDescription
\Zend_Form
methodpublicsetView(\Zend_View_Interface $view = null) : \Zend_Form
inherited

Set view object

Inherited from: \Zend_Form::setView()\Zend_Form_SubForm::setView()
Parameters
NameTypeDescription
$view\Zend_View_Interface
Returns
TypeDescription
\Zend_Form
methodpublictranslatorIsDisabled() : bool
Returns
TypeDescription
bool
methodpublicvalid() : bool
inherited

Determine if current element/subform/display group is valid

Inherited from: \Zend_Form::valid()\Zend_Form_SubForm::valid()
Returns
TypeDescription
bool
Documentation was generated by phpDocumentor 2.0.0a12.