Public Member Functions
	__construct ($name, Zend_Loader_PluginLoader $loader, $options=null)
	Constructor.

	init ()
	Initialize object; used by extending classes.

	setOptions (array $options)
	Set options.

	setConfig (Zend_Config $config)
	Set options from config object.

	setAttrib ($key, $value)
	Set group 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.

	setForm (Zend_Form $form)
	Set form object to which the display group is attached.

	getForm ()
	Get form object to which the group is attached.

	filterName ($value)
	Filter a name to only allow valid variable characters.

	setName ($name)
	Set group name.

	getName ()
	Retrieve group name.

	getFullyQualifiedName ()
	Get fully qualified name.

	getId ()
	Get element id.

	setLegend ($legend)
	Set group legend.

	getLegend ()
	Retrieve group legend.

	setDescription ($value)
	Set description.

	getDescription ()
	Get description.

	setOrder ($order)
	Set group order.

	getOrder ()
	Retrieve group order.

	addElement (Zend_Form_Element $element)
	Add element to stack.

	addElements (array $elements)
	Add multiple elements at once.

	setElements (array $elements)
	Set multiple elements at once (overwrites)

	getElement ($name)
	Retrieve element.

	getElements ()
	Retrieve elements.

	removeElement ($name)
	Remove a single element.

	clearElements ()
	Remove all elements.

	setPluginLoader (Zend_Loader_PluginLoader $loader)
	Set plugin loader.

	getPluginLoader ()
	Retrieve plugin loader.

	addPrefixPath ($prefix, $path)
	Add a prefix path for the plugin loader.

	addPrefixPaths (array $spec)
	Add several prefix paths at once.

	setDisableLoadDefaultDecorators ($flag)
	Set flag to disable loading default decorators.

	loadDefaultDecoratorsIsDisabled ()
	Should we load the default decorators?

	loadDefaultDecorators ()
	Load default decorators.

	addDecorator ($decorator, $options=null)
	Add a decorator for rendering the group.

	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.

	setView (Zend_View_Interface $view=null)
	Set view.

	getView ()
	Retrieve view.

	render (Zend_View_Interface $view=null)
	Render display group.

	__toString ()
	String representation of group.

	setTranslator ($translator=null)
	Set translator object.

	getTranslator ()
	Retrieve translator object.

	hasTranslator ()
	Does this display group have its own specific translator?

	setDisableTranslator ($flag)
	Indicate whether or not translation should be disabled.

	translatorIsDisabled ()
	Is translation disabled?

	__call ($method, $args)
	Overloading: allow rendering specific decorators.

	current ()
	Current element.

	key ()
	Current element.

	next ()
	Move pointer to next element.

	rewind ()
	Move pointer to beginning of element loop.

	valid ()
	Determine if current element/subform/display group is valid.

	count ()
	Count of elements/subforms that are iterable.

Protected Member Functions
	_getDecorator ($name, $options=null)
	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.

Protected Attributes
	$_attribs = array()

	$_decorators = array()

	$_description

	$_disableLoadDefaultDecorators = false

	$_elementOrder = array()

	$_elements = array()

	$_form

	$_groupUpdated = false

	$_loader

	$_name

	$_order

	$_translator

	$_translatorDisabled = false

	$_view

Constructor & Destructor Documentation

__construct	(		$name,
		Zend_Loader_PluginLoader	$loader,
			$options = `null`
	)

Constructor.

Parameters

string	$name
Zend_Loader_PluginLoader	$loader
array \| Zend_Config	$options

Returns: void

Member Function Documentation

__call	(	$method,
		$args
	)

Overloading: allow rendering specific decorators.

Call renderDecoratorName() to render a specific decorator.

Parameters

string	$method
array	$args

Returns: string

Exceptions

Zend_Form_Exception for invalid decorator or invalid method call

__toString ( )

String representation of group.

Returns: string

_getDecorator	(	$name,
		$options = `null`
	)

protected

Instantiate a decorator based on class name or class name fragment.

Parameters

string	$name
null \| array	$options

Returns: Zend_Form_Decorator_Interface

_loadDecorator	(	array	$decorator,
			$name
	)

protected

Lazy-load a decorator.

Parameters

array	$decorator	Decorator type and options
mixed	$name	Decorator name or alias

Returns: Zend_Form_Decorator_Interface

_sort ( )

protected

Sort items according to their order.

Returns: void

addAttribs ( array $attribs )

Add multiple form attributes at once.

Parameters

array $attribs

Returns: Zend_Form_DisplayGroup

addDecorator	(	$decorator,
		$options = `null`
	)

Add a decorator for rendering the group.

Parameters

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

Returns: Zend_Form_DisplayGroup

addDecorators ( array $decorators )

Add many decorators at once.

Parameters

array $decorators

Returns: Zend_Form_DisplayGroup

addElement ( Zend_Form_Element $element )

Add element to stack.

Parameters

Zend_Form_Element $element

Returns: Zend_Form_DisplayGroup

addElements ( array $elements )

Add multiple elements at once.

Parameters

array $elements

Returns: Zend_Form_DisplayGroup

Exceptions

Zend_Form_Exception if any element is not a Zend_Form_Element

addPrefixPath	(	$prefix,
		$path
	)

Add a prefix path for the plugin loader.

Parameters

string	$prefix
string	$path

Returns: Zend_Form_DisplayGroup

addPrefixPaths ( array $spec )

Add several prefix paths at once.

Parameters

array $spec

Returns: Zend_Form_DisplayGroup

clearAttribs ( )

Clear all form attributes.

Returns: Zend_Form

clearDecorators ( )

Clear all decorators.

Returns: Zend_Form_DisplayGroup

clearElements ( )

Remove all elements.

Returns: Zend_Form_DisplayGroup

count ( )

Count of elements/subforms that are iterable.

Returns: int

current ( )

Current element.

Returns: Zend_Form_Element

filterName ( $value )

Filter a name to only allow valid variable characters.

Parameters

string $value

Returns: string

getAttrib ( $key )

Retrieve a single form attribute.

Parameters

string $key

Returns: mixed

getAttribs ( )

Retrieve all form attributes/metadata.

Returns: array

getDecorator ( $name )

Retrieve a registered decorator.

Parameters

string $name

Returns: false|Zend_Form_Decorator_Abstract

getDecorators ( )

Retrieve all decorators.

Returns: array

getDescription ( )

Get description.

Returns: string

getElement ( $name )

Retrieve element.

Parameters

string $name

Returns: Zend_Form_Element|null

getElements ( )

Retrieve elements.

Returns: array

getForm ( )

Get form object to which the group is attached.

Returns: Zend_Form|null

getFullyQualifiedName ( )

Get fully qualified name.

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

Returns: string

getId ( )

Get element id.

Returns: string

getLegend ( )

Retrieve group legend.

Returns: string

getName ( )

Retrieve group name.

Returns: string

getOrder ( )

Retrieve group order.

Returns: int

getPluginLoader ( )

Retrieve plugin loader.

Returns: Zend_Loader_PluginLoader

getTranslator ( )

Retrieve translator object.

Returns: Zend_Translate_Adapter|null

getView ( )

Retrieve view.

Returns: Zend_View_Interface

hasTranslator ( )

Does this display group have its own specific translator?

Returns: bool

init ( )

Initialize object; used by extending classes.

Returns: void

key ( )

Current element.

Returns: string

loadDefaultDecorators ( )

Load default decorators.

Returns: Zend_Form_DisplayGroup

loadDefaultDecoratorsIsDisabled ( )

Should we load the default decorators?

Returns: bool

next ( )

Move pointer to next element.

Returns: void

removeAttrib ( $key )

Remove attribute.

Parameters

string $key

Returns: bool

removeDecorator ( $name )

Remove a single decorator.

Parameters

string $name

Returns: bool

removeElement ( $name )

Remove a single element.

Parameters

string $name

Returns: boolean

render ( Zend_View_Interface $view = null )

Render display group.

Returns: string

rewind ( )

Move pointer to beginning of element loop.

Returns: void

setAttrib	(	$key,
		$value
	)

Set group attribute.

Parameters

string	$key
mixed	$value

Returns: Zend_Form_DisplayGroup

setAttribs ( array $attribs )

Set multiple form attributes at once.

Overwrites any previously set attributes.

Parameters

array $attribs

Returns: Zend_Form_DisplayGroup

setConfig ( Zend_Config $config )

Set options from config object.

Parameters

Zend_Config $config

Returns: Zend_Form_DisplayGroup

setDecorators ( array $decorators )

Overwrite all decorators.

Parameters

array $decorators

Returns: Zend_Form_DisplayGroup

setDescription ( $value )

Set description.

Parameters

string $value

Returns: Zend_Form_DisplayGroup

setDisableLoadDefaultDecorators ( $flag )

Set flag to disable loading default decorators.

Parameters

bool $flag

Returns: Zend_Form_Element

setDisableTranslator ( $flag )

Indicate whether or not translation should be disabled.

Parameters

bool $flag

Returns: Zend_Form_DisplayGroup

setElements ( array $elements )

Set multiple elements at once (overwrites)

Parameters

array $elements

Returns: Zend_Form_DisplayGroup

setForm ( Zend_Form $form )

Set form object to which the display group is attached.

Parameters

Zend_Form $form

Returns: Zend_Form_DisplayGroup

setLegend ( $legend )

Set group legend.

Parameters

string $legend

Returns: Zend_Form_DisplayGroup

setName ( $name )

Set group name.

Parameters

string $name

Returns: Zend_Form_DisplayGroup

setOptions ( array $options )

Set options.

Parameters

array $options

Returns: Zend_Form_DisplayGroup

setOrder ( $order )

Set group order.

Parameters

int $order

Returns: Zend_Form_Element

setPluginLoader ( Zend_Loader_PluginLoader $loader )

Set plugin loader.

Parameters

Zend_Loader_PluginLoader $loader

Returns: Zend_Form_DisplayGroup

setTranslator ( $translator = null )

Set translator object.

Parameters

Zend_Translate | Zend_Translate_Adapter | null $translator

Returns: Zend_Form_DisplayGroup

setView ( Zend_View_Interface $view = null )

Set view.

Parameters

Zend_View_Interface $view

Returns: Zend_Form_DisplayGroup

translatorIsDisabled ( )

Is translation disabled?

Returns: bool

valid ( )

Determine if current element/subform/display group is valid.

Returns: bool

Member Data Documentation

$_attribs = array()

protected

$_decorators = array()

protected

$_description

protected

$_disableLoadDefaultDecorators = false

protected

$_elementOrder = array()

protected

$_elements = array()

protected

$_form

protected

$_groupUpdated = false

protected

$_loader

protected

$_name

protected

$_order

protected

$_translator

protected

$_translatorDisabled = false

protected

$_view

protected

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation