Class Zend_Form

Description

Implements interfaces:

Zend_Form

  • version: $Id: Form.php 18951 2009-11-12 16:26:19Z alexander $
  • copyright: Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  • usedby: Zend_Dojo_Form
  • license: New BSD License

Located in /Form.php (line 33)


	
			
Direct descendents
Class Description
 class Zend_Dojo_Form Dijit-enabled Form
 class Zend_Form_SubForm Zend_Form_SubForm
Class Constant Summary
 DECORATOR = 'DECORATOR'
 ELEMENT = 'ELEMENT'
 ENCTYPE_MULTIPART = 'multipart/form-data'
 ENCTYPE_URLENCODED = 'application/x-www-form-urlencoded'
 METHOD_DELETE = 'delete'
 METHOD_GET = 'get'
 METHOD_POST = 'post'
 METHOD_PUT = 'put'
Variable Summary
Method Summary
 static void setDefaultTranslator ([Zend_Translate|Zend_Translate_Adapter|null $translator = null])
 void __construct ([mixed $options = null])
 Zend_Form addAttribs ( $attribs)
 Zend_Form addDecorator (string|Zend_Form_Decorator_Interface $decorator, [array|Zend_Config $options = null])
 Zend_Form addDecorators ( $decorators)
 Zend_Form addDisplayGroup ( $elements, string $name, [array|Zend_Config $options = null])
 Zend_Form addDisplayGroupPrefixPath (string $prefix, string $path)
 Zend_Form addElement (string|Zend_Form_Element $element, [string $name = null], [array|Zend_Config $options = null])
 Zend_Form addElementPrefixPath (string $prefix, string $path, [string $type = null])
 Zend_Form addElements ( $elements)
 Zend_Form addError (string $message)
 Zend_Form addErrorMessage (string $message)
 Zend_Form addErrorMessages ( $messages)
 Zend_Form addErrors ( $messages)
 Zend_Form addPrefixPath (string $prefix, string $path, [string $type = null])
 Zend_Form addSubForm (Zend_Form $form, string $name, [int $order = null])
 Zend_Form addSubForms ( $subForms)
 int count ()
 Zend_Form_Element createElement (string $type, string $name, [array|Zend_Config $options = null])
 string filterName (string $value, [bool $allowBrackets = false])
 string getAction ()
 mixed getAttrib (string $key)
 array getAttribs ()
 array getDecorators ()
 string getDescription ()
 array getDisplayGroups ()
 Zend_Form_Element|null getElement (string $name)
 array getElements ()
 string|null getElementsBelongTo ()
 string getEnctype ()
 array getErrorMessages ()
 array getErrors ([string $name = null])
 string getId ()
 string getLegend ()
 array getMessages ([string $name = null], [bool $suppressArrayNotation = false])
 string getMethod ()
 null|string getName ()
 int|null getOrder ()
 Zend_Form|null getSubForm (string $name)
 array getSubForms ()
 mixed getUnfilteredValue (string $name)
 mixed getValue (string $name)
 array getValues ([bool $suppressArrayNotation = false])
 void init ()
 bool isArray ()
 bool isErrors ()
 boolean isValid (array $data)
 boolean isValidPartial ( $data)
 string key ()
 void next ()
 void persistData ()
 Zend_Form populate ( $values)
 string processAjax ( $data)
 bool removeAttrib (string $key)
 bool removeDecorator (string $name)
 boolean removeDisplayGroup (string $name)
 boolean removeElement (string $name)
 boolean removeSubForm (string $name)
 string render ([ $view = null])
 void rewind ()
 Zend_Form setAction (string $action)
 Zend_Form setAttrib (string $key, mixed $value)
 Zend_Form setAttribs ( $attribs)
 Zend_Form setConfig ( $config)
 Zend_Form setDecorators ( $decorators)
 Zend_Form setDefault (string $name, mixed $value)
 Zend_Form setDefaults ( $defaults)
 Zend_Form setDescription (string $value)
 Zend_Form setElementDecorators ( $decorators, [ $elements = null], [bool $include = true])
 Zend_Form setElements ( $elements)
 Zend_Form setElementsBelongTo (string $array)
 Zend_Form setEnctype (string $value)
 Zend_Form setErrorMessages ( $messages)
 Zend_Form setErrors ( $messages)
 Zend_Form setIsArray (bool $flag)
 Zend_Form setLegend (string $value)
 Zend_Form setMethod (string $method)
 Zend_Form setName (string $name)
 Zend_Form setOptions ( $options)
 Zend_Form setOrder (int $index)
 Zend_Form setPluginLoader ( $loader, [string $type = null])
 Zend_Form setSubForms ( $subForms)
 Zend_Form setView ([ $view = null])
 bool valid ()
 Zend_Form _addDisplayGroupObject (Zend_Form_DisplayGroup $group, [string|null $name = null])
 array _attachToArray (mixed $value, string $arrayPath)
 string _dissolveArrayValue (array $value, string $arrayPath)
 string _getArrayName (string $value)
 Zend_Form_Decorator_Interface _getDecorator (string $name, null|array $options)
 Zend_Form_Decorator_Interface _loadDecorator ( $decorator, mixed $name)
 void _setElementsBelongTo ([string $name = null])
 void _sort ()
 string __call (string $method, array $args)
 void __clone ()
 Zend_Form_Element|Zend_Form|null __get (string $name)
 boolean __isset (string $name)
 void __set (string $name, Zend_Form_Element|Zend_Form $value)
 string __toString ()
 void __unset (string $name)
Variables
static Zend_Translate $_translatorDefault (line 205)

Global default translation adapter

  • access: protected
array $_attribs = array() (line 62)

Form metadata and attributes

  • access: protected
array $_decorators = array() (line 68)

Decorators for rendering

  • access: protected
string $_defaultDisplayGroupClass = 'Zend_Form_DisplayGroup' (line 74)

Default display group class

  • access: protected
string $_description (line 80)

Form description

  • access: protected
bool $_disableLoadDefaultDecorators = false (line 86)

Should we disable loading the default decorators?

  • access: protected
array $_displayGroupPrefixPaths = array() (line 92)

Display group prefix paths

  • access: protected
array $_displayGroups = array() (line 98)

Groups of elements grouped for display purposes

  • access: protected
null|array $_elementDecorators (line 104)

Global decorators to apply to all elements

  • access: protected
array $_elementPrefixPaths = array() (line 110)

Prefix paths to use when creating elements

  • access: protected
array $_elements = array() (line 116)

Form elements

  • access: protected
string $_elementsBelongTo (line 122)

Array to which elements belong (if any)

  • access: protected
array $_errorMessages = array() (line 128)

Custom form-level error messages

  • access: protected
bool $_errorsExist = false (line 134)

Are there errors in the form?

  • access: protected
bool $_errorsForced = false (line 140)

Has the form been manually flagged as an error?

  • access: protected
int|null $_formOrder (line 146)

Form order

  • access: protected
bool $_isArray = false (line 152)

Whether or not form elements are members of an array

  • access: protected

Redefined in descendants as:
string $_legend (line 158)

Form legend

  • access: protected
array $_loaders = array() (line 164)

Plugin loaders

  • access: protected
array $_methods = array('delete', 'get', 'post', 'put') (line 170)

Allowed form methods

  • access: protected
array $_order = array() (line 176)

Order in which to display and iterate elements

  • access: protected
bool $_orderUpdated = false (line 182)

Whether internal order has been updated or not

  • access: protected
array $_subFormPrefixPaths = array() (line 188)

Sub form prefix paths

  • access: protected
array $_subForms = array() (line 194)

Sub forms

  • access: protected
Zend_Translate $_translator (line 199)
  • access: protected
bool $_translatorDisabled = false (line 211)

is the translator disabled?

  • access: protected
Zend_View_Interface $_view (line 216)
  • access: protected
Methods
static getDefaultTranslator (line 2719)

Get global default translator object

  • access: public
static null|Zend_Translate getDefaultTranslator ()
static setDefaultTranslator (line 2682)

Set global default translator object

  • access: public
static void setDefaultTranslator ([Zend_Translate|Zend_Translate_Adapter|null $translator = null])
Constructor __construct (line 226)

Constructor

Registers form view helper as decorator

  • access: public
void __construct ([mixed $options = null])
  • mixed $options

Redefined in descendants as:
addAttribs (line 657)

Add multiple form attributes at once

  • access: public
Zend_Form addAttribs ( $attribs)
  • array $attribs
addDecorator (line 2367)

Add a decorator for rendering the element

  • access: public
Zend_Form addDecorator (string|Zend_Form_Decorator_Interface $decorator, [array|Zend_Config $options = null])
addDecorators (line 2409)

Add many decorators at once

  • access: public
Zend_Form addDecorators ( $decorators)
  • array $decorators
addDisplayGroup (line 1651)

Add a display group

Groups named elements for display purposes.

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

  • throws: Zend_Form_Exception if no valid elements provided
  • access: public
Zend_Form addDisplayGroup ( $elements, string $name, [array|Zend_Config $options = null])
  • array $elements
  • string $name
  • array|Zend_Config $options
addDisplayGroupPrefixPath (line 584)

Add prefix path for all display groups

  • access: public
Zend_Form addDisplayGroupPrefixPath (string $prefix, string $path)
  • string $prefix
  • string $path
addDisplayGroupPrefixPaths (line 604)

Add multiple display group prefix paths at once

  • access: public
Zend_Form addDisplayGroupPrefixPaths ( $spec)
  • array $spec
addDisplayGroups (line 1739)

Add multiple display groups at once

  • access: public
Zend_Form addDisplayGroups ( $groups)
  • array $groups
addElement (line 988)

Add a new element

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

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

  • access: public
Zend_Form addElement (string|Zend_Form_Element $element, [string $name = null], [array|Zend_Config $options = null])
addElementPrefixPath (line 541)

Add prefix path for all elements

  • access: public
Zend_Form addElementPrefixPath (string $prefix, string $path, [string $type = null])
  • string $prefix
  • string $path
  • string $type
addElementPrefixPaths (line 566)

Add prefix paths for all elements

  • access: public
Zend_Form addElementPrefixPaths ( $spec)
  • array $spec
addElements (line 1089)

Add multiple elements at once

  • access: public
Zend_Form addElements ( $elements)
  • array $elements
addError (line 2174)

Add an error message and mark element as failed validation

  • access: public
Zend_Form addError (string $message)
  • string $message
addErrorMessage (line 2103)

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

  • access: public
Zend_Form addErrorMessage (string $message)
  • string $message
addErrorMessages (line 2115)

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

  • access: public
Zend_Form addErrorMessages ( $messages)
  • array $messages
addErrors (line 2187)

Add multiple error messages and flag element as failed validation

  • access: public
Zend_Form addErrors ( $messages)
  • array $messages
addPrefixPath (line 477)

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 'decorators', sets the path in the decorator plugin loader for all elements. Additionally, if no $type is provided, Zend_Form_Element::addPrefixPath() is called on each element.

  • throws: Zend_Form_Exception for invalid type
  • access: public
Zend_Form addPrefixPath (string $prefix, string $path, [string $type = null])
  • string $prefix
  • string $path
  • string $type
addPrefixPaths (line 509)

Add many prefix paths at once

  • access: public
Zend_Form addPrefixPaths ( $spec)
  • array $spec
addSubForm (line 1462)

Add a form group/subform

  • access: public
Zend_Form addSubForm (Zend_Form $form, string $name, [int $order = null])
addSubForms (line 1505)

Add multiple form subForms/subforms at once

  • access: public
Zend_Form addSubForms ( $subForms)
  • array $subForms
clearAttribs (line 726)

Clear all form attributes

  • access: public
Zend_Form clearAttribs ()
clearDecorators (line 2536)

Clear all decorators

  • access: public
Zend_Form clearDecorators ()
clearDisplayGroups (line 1864)

Remove all display groups

  • access: public
Zend_Form clearDisplayGroups ()
clearElements (line 1207)

Remove all form elements

  • access: public
Zend_Form clearElements ()
clearErrorMessages (line 2150)

Clear custom error messages stack

  • access: public
Zend_Form clearErrorMessages ()
clearSubForms (line 1601)

Remove all form subForms/subforms

  • access: public
Zend_Form clearSubForms ()
count (line 2946)

Count of elements/subforms that are iterable

  • access: public
int count ()

Implementation of:
Countable::count
createElement (line 1045)

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

  • access: public
Zend_Form_Element createElement (string $type, string $name, [array|Zend_Config $options = null])
current (line 2879)

Current element/subform/display group

  • access: public

Implementation of:
Iterator::current
filterName (line 827)

Filter a name to only allow valid variable characters

  • access: public
string filterName (string $value, [bool $allowBrackets = false])
  • string $value
  • bool $allowBrackets
getAction (line 750)

Get form action

Sets default to '' if not set.

  • access: public
string getAction ()
getAttrib (line 685)

Retrieve a single form attribute

  • access: public
mixed getAttrib (string $key)
  • string $key
getAttribs (line 700)

Retrieve all form attributes/metadata

  • access: public
array getAttribs ()
getDecorator (line 2465)

Retrieve a registered decorator

  • access: public
false|Zend_Form_Decorator_Abstract getDecorator (string $name)
  • string $name
getDecorators (line 2496)

Retrieve all decorators

  • access: public
array getDecorators ()
getDefaultDisplayGroupClass (line 1633)

Retrieve default display group class

  • access: public
string getDefaultDisplayGroupClass ()
getDescription (line 943)

Retrieve form description

  • access: public
string getDescription ()
getDisplayGroup (line 1811)

Return a display group

  • access: public
Zend_Form_DisplayGroup|null getDisplayGroup (string $name)
  • string $name
getDisplayGroups (line 1826)

Return all display groups

  • access: public
array getDisplayGroups ()
getElement (line 1157)

Retrieve a single element

  • access: public
Zend_Form_Element|null getElement (string $name)
  • string $name
getElements (line 1170)

Retrieve all elements

  • access: public
array getElements ()
getElementsBelongTo (line 1419)

Get name of array elements belong to

  • access: public
string|null getElementsBelongTo ()
getEnctype (line 811)

Get encoding type

  • access: public
string getEnctype ()
getErrorMessages (line 2140)

Retrieve custom error messages

  • access: public
array getErrorMessages ()
getErrors (line 2228)

Get error codes for all elements failing validation

  • access: public
array getErrors ([string $name = null])
  • string $name
getFullyQualifiedName (line 870)

Get fully qualified name

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

  • access: public
string getFullyQualifiedName ()
getId (line 880)

Get element id

  • access: public
string getId ()
getLegend (line 921)

Get form legend

  • access: public
string getLegend ()
getMessages (line 2254)

Retrieve error messages from elements failing validations

  • access: public
array getMessages ([string $name = null], [bool $suppressArrayNotation = false])
  • string $name
  • bool $suppressArrayNotation
getMethod (line 785)

Retrieve form method

  • access: public
string getMethod ()
getName (line 858)

Get name attribute

  • access: public
null|string getName ()
getOrder (line 965)

Get form order

  • access: public
int|null getOrder ()
getPluginLoader (line 430)

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.

  • access: public
Zend_Loader_PluginLoader_Interface getPluginLoader ([string $type = null])
  • string $type
getSubForm (line 1556)

Retrieve a form subForm/subform

  • access: public
Zend_Form|null getSubForm (string $name)
  • string $name
getSubForms (line 1570)

Retrieve all form subForms/subforms

  • access: public
array getSubForms ()
getTranslator (line 2701)

Retrieve translator object

  • access: public
Zend_Translate|null getTranslator ()
getUnfilteredValue (line 1324)

Get unfiltered element value

  • access: public
mixed getUnfilteredValue (string $name)
  • string $name
getUnfilteredValues (line 1337)

Retrieve all unfiltered element values

  • access: public
array getUnfilteredValues ()
getValue (line 1274)

Retrieve value for single element

  • access: public
mixed getValue (string $name)
  • string $name
getValues (line 1298)

Retrieve all form element values

  • access: public
array getValues ([bool $suppressArrayNotation = false])
  • bool $suppressArrayNotation
getView (line 2330)

Retrieve view object

If none registered, attempts to pull from ViewRenderer.

  • access: public
Zend_View_Interface|null getView ()

Redefined in descendants as:
init (line 294)

Initialize form (used by extending classes)

  • access: public
void init ()
isArray (line 1447)

Get flag indicating if elements belong to an array

  • access: public
bool isArray ()
isErrors (line 2217)

Are there errors in the form?

  • access: public
bool isErrors ()
isValid (line 1991)

Validate the form

  • access: public
boolean isValid (array $data)
  • array $data
isValidPartial (line 2039)

Validate a partial form

Does not check for required flags.

  • access: public
boolean isValidPartial ( $data)
  • array $data
key (line 2902)

Current element/subform/display group name

  • access: public
string key ()

Implementation of:
Iterator::key
loadDefaultDecorators (line 2978)

Load the default decorators

  • access: public
void loadDefaultDecorators ()

Redefined in descendants as:
loadDefaultDecoratorsIsDisabled (line 2968)

Should we load the default decorators?

  • access: public
bool loadDefaultDecoratorsIsDisabled ()
markAsError (line 2161)

Mark the element as being in a failed validation state

  • access: public
Zend_Form markAsError ()
next (line 2913)

Move pointer to next element/subform/display group

  • access: public
void next ()

Implementation of:
Iterator::next
persistData (line 2208)
  • access: public
void persistData ()
populate (line 1893)

Populate form

Proxies to setDefaults()

  • access: public
Zend_Form populate ( $values)
  • array $values
processAjax (line 2087)

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

  • return: JSON-encoded boolean true or error messages
  • access: public
string processAjax ( $data)
  • array $data
removeAttrib (line 711)

Remove attribute

  • access: public
bool removeAttrib (string $key)
  • string $key
removeDecorator (line 2512)

Remove a single decorator

  • access: public
bool removeDecorator (string $name)
  • string $name
removeDisplayGroup (line 1837)

Remove a display group by name

  • access: public
boolean removeDisplayGroup (string $name)
  • string $name
removeElement (line 1181)

Remove element

  • access: public
boolean removeElement (string $name)
  • string $name
removeSubForm (line 1581)

Remove form subForm/subform

  • access: public
boolean removeSubForm (string $name)
  • string $name
render (line 2617)

Render form

  • access: public
string render ([ $view = null])
reset (line 277)

Reset values of form

  • access: public
Zend_Form reset ()
rewind (line 2924)

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

  • access: public
void rewind ()

Implementation of:
Iterator::rewind
setAction (line 738)

Set form action

  • access: public
Zend_Form setAction (string $action)
  • string $action
setAttrib (line 644)

Set form attribute

  • access: public
Zend_Form setAttrib (string $key, mixed $value)
  • string $key
  • mixed $value
setAttribs (line 673)

Set multiple form attributes at once

Overwrites any previously set attributes.

  • access: public
Zend_Form setAttribs ( $attribs)
  • array $attribs
setConfig (line 387)

Set form state from config object

  • access: public
Zend_Form setConfig ( $config)
setDecorators (line 2453)

Overwrite all decorators

  • access: public
Zend_Form setDecorators ( $decorators)
  • array $decorators
setDefault (line 1251)

Set default value for an element

  • access: public
Zend_Form setDefault (string $name, mixed $value)
  • string $name
  • mixed $value
setDefaultDisplayGroupClass (line 1622)

Set default display group class

  • access: public
Zend_Form setDefaultDisplayGroupClass (string $class)
  • string $class
setDefaults (line 1227)

Set default values for elements

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

  • access: public
Zend_Form setDefaults ( $defaults)
  • array $defaults
setDescription (line 932)

Set form description

  • access: public
Zend_Form setDescription (string $value)
  • string $value
setDisableLoadDefaultDecorators (line 2957)

Set flag to disable loading default decorators

  • access: public
Zend_Form setDisableLoadDefaultDecorators (bool $flag)
  • bool $flag
setDisableTranslator (line 2741)

Indicate whether or not translation should be disabled

  • access: public
Zend_Form setDisableTranslator (bool $flag)
  • bool $flag
setDisplayGroupDecorators (line 2587)

Set all display group decorators as specified

  • access: public
Zend_Form setDisplayGroupDecorators ( $decorators)
  • array $decorators
setDisplayGroups (line 1799)

Add multiple display groups (overwrites)

  • access: public
Zend_Form setDisplayGroups ( $groups)
  • array $groups
setElementDecorators (line 2550)

Set all element decorators as specified

  • access: public
Zend_Form setElementDecorators ( $decorators, [ $elements = null], [bool $include = true])
  • array $decorators
  • array|null $elements: Specific elements to decorate or exclude from decoration
  • bool $include: Whether $elements is an inclusion or exclusion list
setElementFilters (line 1353)

Set all elements' filters

  • access: public
Zend_Form setElementFilters ( $filters)
  • array $filters
setElements (line 1145)

Set form elements (overwrites existing elements)

  • access: public
Zend_Form setElements ( $elements)
  • array $elements
setElementsBelongTo (line 1367)

Set name of array elements belong to

  • access: public
Zend_Form setElementsBelongTo (string $array)
  • string $array
setEnctype (line 800)

Set encoding type

  • access: public
Zend_Form setEnctype (string $value)
  • string $value
setErrorMessages (line 2129)

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

  • access: public
Zend_Form setErrorMessages ( $messages)
  • array $messages
setErrors (line 2201)

Overwrite any previously set error messages and flag as failed validation

  • access: public
Zend_Form setErrors ( $messages)
  • array $messages
setIsArray (line 1436)

Set flag indicating elements belong to array

  • access: public
Zend_Form setIsArray (bool $flag)
  • bool $flag: Value of flag
setLegend (line 910)

Set form legend

  • access: public
Zend_Form setLegend (string $value)
  • string $value
setMethod (line 769)

Set form method

Only values in $_methods() allowed

  • throws: Zend_Form_Exception
  • access: public
Zend_Form setMethod (string $method)
  • string $method
setName (line 842)

Set form name

  • access: public
Zend_Form setName (string $name)
  • string $name
setOptions (line 304)

Set form state from options array

  • access: public
Zend_Form setOptions ( $options)
  • array $options
setOrder (line 954)

Set form order

  • access: public
Zend_Form setOrder (int $index)
  • int $index
setPluginLoader (line 403)

Set plugin loaders for use with decorators and elements

  • throws: Zend_Form_Exception on invalid type
  • access: public
Zend_Form setPluginLoader ( $loader, [string $type = null])
setSubFormDecorators (line 2602)

Set all subform decorators as specified

  • access: public
Zend_Form setSubFormDecorators ( $decorators)
  • array $decorators
setSubForms (line 1544)

Set multiple form subForms/subforms (overwrites)

  • access: public
Zend_Form setSubForms ( $subForms)
  • array $subForms
setTranslator (line 2660)

Set translator object

  • access: public
Zend_Form setTranslator ([Zend_Translate|Zend_Translate_Adapter|null $translator = null])
setView (line 2317)

Set view object

  • access: public
Zend_Form setView ([ $view = null])

Redefined in descendants as:
translatorIsDisabled (line 2752)

Is translation disabled?

  • access: public
bool translatorIsDisabled ()
valid (line 2935)

Determine if current element/subform/display group is valid

  • access: public
bool valid ()

Implementation of:
Iterator::valid
_addDisplayGroupObject (line 1712)

Add a display group object (used with cloning)

  • access: protected
Zend_Form _addDisplayGroupObject (Zend_Form_DisplayGroup $group, [string|null $name = null])
_attachToArray (line 1966)

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

  • access: protected
array _attachToArray (mixed $value, string $arrayPath)
  • mixed $value: The value to attach
  • string $arrayPath: Given array path to convert and attach to.
_dissolveArrayValue (line 1936)

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

  • access: protected
string _dissolveArrayValue (array $value, string $arrayPath)
  • array $value: Array to walk
  • string $arrayPath: Array notation path of the part to extract
_getArrayName (line 1906)

Determine array key name from given value

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

  • access: protected
string _getArrayName (string $value)
  • string $value
_getDecorator (line 2348)

Instantiate a decorator based on class name or class name fragment

  • access: protected
Zend_Form_Decorator_Interface _getDecorator (string $name, null|array $options)
  • string $name
  • null|array $options
_getErrorMessages (line 3068)

Retrieve optionally translated custom error messages

  • access: protected
array _getErrorMessages ()
_loadDecorator (line 3032)

Lazy-load a decorator

  • access: protected
Zend_Form_Decorator_Interface _loadDecorator ( $decorator, mixed $name)
  • array $decorator: Decorator type and options
  • mixed $name: Decorator name or alias
_setElementsBelongTo (line 1395)

Set array to which elements belong

  • access: protected
void _setElementsBelongTo ([string $name = null])
  • string $name: Element name
_sort (line 2997)

Sort items according to their order

  • access: protected
void _sort ()
__call (line 2851)

Overloading: allow rendering specific decorators

Call renderDecoratorName() to render a specific decorator.

  • throws: Zend_Form_Exception for invalid decorator or invalid method call
  • access: public
string __call (string $method, array $args)
  • string $method
  • array $args
__clone (line 245)

Clone form object and all children

  • access: public
void __clone ()
__get (line 2763)

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

  • access: public
Zend_Form_Element|Zend_Form|null __get (string $name)
  • string $name
__isset (line 2812)

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

  • access: public
boolean __isset (string $name)
  • string $name
__set (line 2784)

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

  • throws: Zend_Form_Exception for invalid $value
  • access: public
void __set (string $name, Zend_Form_Element|Zend_Form $value)
__toString (line 2638)

Serialize as string

Proxies to render().

  • access: public
string __toString ()
__unset (line 2830)

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

  • access: public
void __unset (string $name)
  • string $name
Class Constants
DECORATOR = 'DECORATOR' (line 38)

Plugin loader type constants

ELEMENT = 'ELEMENT' (line 39)

Plugin loader type constants

ENCTYPE_MULTIPART = 'multipart/form-data' (line 55)

Encoding type constants

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

Encoding type constants

METHOD_DELETE = 'delete' (line 45)

Method type constants

METHOD_GET = 'get' (line 46)

Method type constants

METHOD_POST = 'post' (line 47)

Method type constants

METHOD_PUT = 'put' (line 48)

Method type constants

Documentation generated on Thu, 01 Apr 2010 13:07:41 -0400 by phpDocumentor 1.4.3