Zend_Form_SubForm Class Reference

Public Member Functions
	loadDefaultDecorators ()
	Load the default decorators.
Public Member Functions inherited from Zend_Form
	__construct ($options=null)
	Constructor.
	__clone ()
	Clone form object and all children.
	reset ()
	Reset values of form.
	init ()
	Initialize form (used by extending classes)
	setOptions (array $options)
	Set form state from options array.
	setConfig (Zend_Config $config)
	Set form state from config object.
	setPluginLoader (Zend_Loader_PluginLoader_Interface $loader, $type=null)
	Set plugin loaders for use with decorators and elements.
	getPluginLoader ($type=null)
	Retrieve plugin loader for given type.
	addPrefixPath ($prefix, $path, $type=null)
	Add prefix path for plugin loader.
	addPrefixPaths (array $spec)
	Add many prefix paths at once.
	addElementPrefixPath ($prefix, $path, $type=null)
	Add prefix path for all elements.
	addElementPrefixPaths (array $spec)
	Add prefix paths for all elements.
	addDisplayGroupPrefixPath ($prefix, $path)
	Add prefix path for all display groups.
	addDisplayGroupPrefixPaths (array $spec)
	Add multiple display group prefix paths at once.
	setAttrib ($key, $value)
	Set form attribute.
	addAttribs (array $attribs)
	Add multiple form attributes at once.
	setAttribs (array $attribs)
	Set multiple form attributes at once.
	getAttrib ($key)
	Retrieve a single form attribute.
	getAttribs ()
	Retrieve all form attributes/metadata.
	removeAttrib ($key)
	Remove attribute.
	clearAttribs ()
	Clear all form attributes.
	setAction ($action)
	Set form action.
	getAction ()
	Get form action.
	setMethod ($method)
	Set form method.
	getMethod ()
	Retrieve form method.
	setEnctype ($value)
	Set encoding type.
	getEnctype ()
	Get encoding type.
	filterName ($value, $allowBrackets=false)
	Filter a name to only allow valid variable characters.
	setName ($name)
	Set form name.
	getName ()
	Get name attribute.
	getFullyQualifiedName ()
	Get fully qualified name.
	getId ()
	Get element id.
	setLegend ($value)
	Set form legend.
	getLegend ()
	Get form legend.
	setDescription ($value)
	Set form description.
	getDescription ()
	Retrieve form description.
	setOrder ($index)
	Set form order.
	getOrder ()
	Get form order.
	addElement ($element, $name=null, $options=null)
	Add a new element.
	createElement ($type, $name, $options=null)
	Create an element.
	addElements (array $elements)
	Add multiple elements at once.
	setElements (array $elements)
	Set form elements (overwrites existing elements)
	getElement ($name)
	Retrieve a single element.
	getElements ()
	Retrieve all elements.
	removeElement ($name)
	Remove element.
	clearElements ()
	Remove all form elements.
	setDefaults (array $defaults)
	Set default values for elements.
	setDefault ($name, $value)
	Set default value for an element.
	getValue ($name)
	Retrieve value for single element.
	getValues ($suppressArrayNotation=false)
	Retrieve all form element values.
	getValidValues ($data, $suppressArrayNotation=false)
	Returns only the valid values from the given form input.
	getUnfilteredValue ($name)
	Get unfiltered element value.
	getUnfilteredValues ()
	Retrieve all unfiltered element values.
	setElementFilters (array $filters)
	Set all elements' filters.
	setElementsBelongTo ($array)
	Set name of array elements belong to.
	getElementsBelongTo ()
	Get name of array elements belong to.
	setIsArray ($flag)
	Set flag indicating elements belong to array.
	isArray ()
	Get flag indicating if elements belong to an array.
	addSubForm (Zend_Form $form, $name, $order=null)
	Add a form group/subform.
	addSubForms (array $subForms)
	Add multiple form subForms/subforms at once.
	setSubForms (array $subForms)
	Set multiple form subForms/subforms (overwrites)
	getSubForm ($name)
	Retrieve a form subForm/subform.
	getSubForms ()
	Retrieve all form subForms/subforms.
	removeSubForm ($name)
	Remove form subForm/subform.
	clearSubForms ()
	Remove all form subForms/subforms.
	setDefaultDisplayGroupClass ($class)
	Set default display group class.
	getDefaultDisplayGroupClass ()
	Retrieve default display group class.
	addDisplayGroup (array $elements, $name, $options=null)
	Add a display group.
	addDisplayGroups (array $groups)
	Add multiple display groups at once.
	setDisplayGroups (array $groups)
	Add multiple display groups (overwrites)
	getDisplayGroup ($name)
	Return a display group.
	getDisplayGroups ()
	Return all display groups.
	removeDisplayGroup ($name)
	Remove a display group by name.
	clearDisplayGroups ()
	Remove all display groups.
	populate (array $values)
	Populate form.
	getElementsAndSubFormsOrdered ()
	Returns a one dimensional numerical indexed array with the Elements, SubForms and Elements from DisplayGroups as Values.
	isValid ($data)
	Validate the form.
	isValidPartial (array $data)
	Validate a partial form.
	processAjax (array $data)
	Process submitted AJAX data.
	addErrorMessage ($message)
	Add a custom error message to return in the event of failed validation.
	addErrorMessages (array $messages)
	Add multiple custom error messages to return in the event of failed validation.
	setErrorMessages (array $messages)
	Same as addErrorMessages(), but clears custom error message stack first.
	getErrorMessages ()
	Retrieve custom error messages.
	clearErrorMessages ()
	Clear custom error messages stack.
	markAsError ()
	Mark the element as being in a failed validation state.
	addError ($message)
	Add an error message and mark element as failed validation.
	addErrors (array $messages)
	Add multiple error messages and flag element as failed validation.
	setErrors (array $messages)
	Overwrite any previously set error messages and flag as failed validation.
	persistData ()
	isErrors ()
	Are there errors in the form?
	hasErrors ()
	Are there errors in the form?
	getErrors ($name=null, $suppressArrayNotation=false)
	Get error codes for all elements failing validation.
	getMessages ($name=null, $suppressArrayNotation=false)
	Retrieve error messages from elements failing validations.
	getCustomMessages ()
	Retrieve translated custom error messages Proxies to _getErrorMessages().
	setView (Zend_View_Interface $view=null)
	Set view object.
	getView ()
	Retrieve view object.
	addDecorator ($decorator, $options=null)
	Add a decorator for rendering the element.
	addDecorators (array $decorators)
	Add many decorators at once.
	setDecorators (array $decorators)
	Overwrite all decorators.
	getDecorator ($name)
	Retrieve a registered decorator.
	getDecorators ()
	Retrieve all decorators.
	removeDecorator ($name)
	Remove a single decorator.
	clearDecorators ()
	Clear all decorators.
	setElementDecorators (array $decorators, array $elements=null, $include=true)
	Set all element decorators as specified.
	setDisplayGroupDecorators (array $decorators)
	Set all display group decorators as specified.
	setSubFormDecorators (array $decorators)
	Set all subform decorators as specified.
	render (Zend_View_Interface $view=null)
	Render form.
	__toString ()
	Serialize as string.
	setTranslator ($translator=null)
	Set translator object.
	getTranslator ()
	Retrieve translator object.
	hasTranslator ()
	Does this form have its own specific translator?
	setDisableTranslator ($flag)
	Indicate whether or not translation should be disabled.
	translatorIsDisabled ()
	Is translation disabled?
	__get ($name)
	Overloading: access to elements, form groups, and display groups.
	__set ($name, $value)
	Overloading: access to elements, form groups, and display groups.
	__isset ($name)
	Overloading: access to elements, form groups, and display groups.
	__unset ($name)
	Overloading: access to elements, form groups, and display groups.
	__call ($method, $args)
	Overloading: allow rendering specific decorators.
	current ()
	Current element/subform/display group.
	key ()
	Current element/subform/display group name.
	next ()
	Move pointer to next element/subform/display group.
	rewind ()
	Move pointer to beginning of element/subform/display group loop.
	valid ()
	Determine if current element/subform/display group is valid.
	count ()
	Count of elements/subforms that are iterable.
	setDisableLoadDefaultDecorators ($flag)
	Set flag to disable loading default decorators.
	loadDefaultDecoratorsIsDisabled ()
	Should we load the default decorators?
	loadDefaultDecorators ()
	Load the default decorators.
	removeFromIteration ($name)
	Remove an element from iteration.
Public Member Functions inherited from Zend_Validate_Interface
	getMessages ()
	Returns an array of messages that explain why the most recent isValid() call returned false.

Protected Attributes
	$_isArray = true
Protected Attributes inherited from Zend_Form
	$_attribs = array()
	$_decorators = array()
	$_defaultDisplayGroupClass = 'Zend_Form_DisplayGroup'
	$_description
	$_disableLoadDefaultDecorators = false
	$_displayGroupPrefixPaths = array()
	$_displayGroups = array()
	$_elementDecorators
	$_elementPrefixPaths = array()
	$_elements = array()
	$_elementsBelongTo
	$_errorMessages = array()
	$_errorsExist = false
	$_errorsForced = false
	$_formOrder
	$_isArray = false
	$_legend
	$_loaders = array()
	$_methods = array('delete', 'get', 'post', 'put')
	$_order = array()
	$_orderUpdated = false
	$_subFormPrefixPaths = array()
	$_subForms = array()
	$_translator
	$_translatorDisabled = false
	$_view
	$_isRendered = false

Additional Inherited Members
Static Public Member Functions inherited from Zend_Form
static	setDefaultTranslator ($translator=null)
	Set global default translator object.
static	getDefaultTranslator ()
	Get global default translator object.
static	hasDefaultTranslator ()
	Is there a default translation object set?
Public Attributes inherited from Zend_Form
const	DECORATOR = 'DECORATOR'
	#@+ Plugin loader type constants
const	ELEMENT = 'ELEMENT'
const	METHOD_DELETE = 'delete'
	#@-
const	METHOD_GET = 'get'
const	METHOD_POST = 'post'
const	METHOD_PUT = 'put'
const	ENCTYPE_URLENCODED = 'application/x-www-form-urlencoded'
	#@-
const	ENCTYPE_MULTIPART = 'multipart/form-data'
Protected Member Functions inherited from Zend_Form
	_setIsRendered ()
	When calling renderFormElements or render this method is used to set $_isRendered member to prevent repeatedly merging belongsTo setting.
	_getIsRendered ()
	Get the value of $_isRendered member.
	_setElementsBelongTo ($name=null)
	Set array to which elements belong.
	_addDisplayGroupObject (Zend_Form_DisplayGroup $group, $name=null)
	Add a display group object (used with cloning)
	_getArrayName ($value)
	Determine array key name from given value.
	_dissolveArrayValue ($value, $arrayPath)
	Extract the value by walking the array using given array path.
	_dissolveArrayUnsetKey ($array, $arrayPath, $key)
	Given an array, an optional arrayPath and a key this method dissolves the arrayPath and unsets the key within the array if it exists.
	_attachToArray ($value, $arrayPath)
	Converts given arrayPath to an array and attaches given value at the end of it.
	_array_replace_recursive (array $into)
	This is a helper function until php 5.3 is widespreaded.
	_getDecorator ($name, $options)
	Instantiate a decorator based on class name or class name fragment.
	_sort ()
	Sort items according to their order.
	_loadDecorator (array $decorator, $name)
	Lazy-load a decorator.
	_getErrorMessages ()
	Retrieve optionally translated custom error messages.
Static Protected Attributes inherited from Zend_Form
static	$_translatorDefault

Member Function Documentation

loadDefaultDecorators

(

)

Load the default decorators.

Returns

Zend_Form_SubForm

Member Data Documentation

$_isArray = true

protected