Dijit-enabled DisplayGroup

uses
package Zend_Dojo
subpackage Form
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
version $Id$
inherited_from \Zend_Form_DisplayGroup

 Methods

Overloading: allow rendering specific decorators

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

Call renderDecoratorName() to render a specific decorator.

Parameters

$method

string

$args

array

Exceptions

\Zend_Form_Exception for invalid decorator or invalid method call

Returns

string

Constructor

__construct(string $name, \Zend_Loader_PluginLoader $loader, array|\Zend_Config|null $options = null) : void
inherited_from \Zend_Form_DisplayGroup::__construct()

Parameters

$name

string

$loader

\Zend_Loader_PluginLoader

$options

array\Zend_Confignull

Constructor

__construct(string $name, \Zend_Loader_PluginLoader $loader, array|\Zend_Config $options = null) : void
Inherited

Parameters

$name

string

$loader

\Zend_Loader_PluginLoader

$options

array\Zend_Config

String representation of group

__toString() : string
Inherited

Returns

string

Add multiple form attributes at once

addAttribs(array $attribs) : \Zend_Form_DisplayGroup
Inherited

Parameters

$attribs

array

Returns

\Zend_Form_DisplayGroup

Add a decorator for rendering the group

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

Parameters

$decorator

string\Zend_Form_Decorator_Interface

$options

array\Zend_Config

Options with which to initialize decorator

Returns

\Zend_Form_DisplayGroup

Add many decorators at once

addDecorators(array $decorators) : \Zend_Form_DisplayGroup
Inherited

Parameters

$decorators

array

Returns

\Zend_Form_DisplayGroup

Add element to stack

addElement(\Zend_Form_Element $element) : \Zend_Form_DisplayGroup
Inherited

Parameters

$element

\Zend_Form_Element

Returns

\Zend_Form_DisplayGroup

Add multiple elements at once

addElements(array $elements) : \Zend_Form_DisplayGroup
Inherited

Parameters

$elements

array

Exceptions

\Zend_Form_Exception if any element is not a Zend_Form_Element

Returns

\Zend_Form_DisplayGroup

Add a prefix path for the plugin loader

addPrefixPath(string $prefix, string $path) : \Zend_Form_DisplayGroup
Inherited

Parameters

$prefix

string

$path

string

Returns

\Zend_Form_DisplayGroup

Add several prefix paths at once

addPrefixPaths(array $spec) : \Zend_Form_DisplayGroup
Inherited

Parameters

$spec

array

Returns

\Zend_Form_DisplayGroup

Clear all form attributes

clearAttribs() : \Zend_Form
Inherited

Returns

\Zend_Form

Clear all decorators

clearDecorators() : \Zend_Form_DisplayGroup
Inherited

Returns

\Zend_Form_DisplayGroup

Remove all elements

clearElements() : \Zend_Form_DisplayGroup
Inherited

Returns

\Zend_Form_DisplayGroup

Count of elements/subforms that are iterable

count() : integer
Inherited

Returns

integer

Current element

current() : \Zend_Form_Element
Inherited

Returns

\Zend_Form_Element

Filter a name to only allow valid variable characters

filterName(string $value) : string
Inherited

Parameters

$value

string

Returns

string

Retrieve a single form attribute

getAttrib(string $key) : mixed
Inherited

Parameters

$key

string

Returns

mixed

Retrieve all form attributes/metadata

getAttribs() : array
Inherited

Returns

array

Retrieve a registered decorator

getDecorator(string $name) : false | \Zend_Form_Decorator_Abstract
Inherited

Parameters

$name

string

Returns

false\Zend_Form_Decorator_Abstract

Retrieve all decorators

getDecorators() : array
Inherited

Returns

array

Get description

getDescription() : string
Inherited

Returns

string

Retrieve element

getElement(string $name) : \Zend_Form_Element | null
Inherited

Parameters

$name

string

Returns

\Zend_Form_Elementnull

Retrieve elements

getElements() : array
Inherited

Returns

array

Get form object to which the group is attached

getForm() : \Zend_Form | null
Inherited

Returns

\Zend_Formnull

Get fully qualified name

getFullyQualifiedName() : string
Inherited

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

Returns

string

Get element id

getId() : string
Inherited

Returns

string

Retrieve group legend

getLegend() : string
Inherited

Returns

string

Retrieve group name

getName() : string
Inherited

Returns

string

Retrieve group order

getOrder() : integer
Inherited

Returns

integer

Retrieve plugin loader

getPluginLoader() : \Zend_Loader_PluginLoader
Inherited

Returns

\Zend_Loader_PluginLoader

Retrieve translator object

getTranslator() : \Zend_Translate_Adapter | null
Inherited

Returns

\Zend_Translate_Adapternull

Retrieve view

getView() : \Zend_View_Interface
Inherited

Returns

\Zend_View_Interface

Does this display group have its own specific translator?

hasTranslator() : boolean
Inherited

Returns

boolean

Initialize object; used by extending classes

init() : void
Inherited

Current element

key() : string
Inherited

Returns

string

Load default decorators

loadDefaultDecorators() : \Zend_Form_DisplayGroup
Inherited

Returns

\Zend_Form_DisplayGroup

Should we load the default decorators?

loadDefaultDecoratorsIsDisabled() : boolean
Inherited

Returns

boolean

Move pointer to next element

next() : void
Inherited

Remove attribute

removeAttrib(string $key) : boolean
Inherited

Parameters

$key

string

Returns

boolean

Remove a single decorator

removeDecorator(string $name) : boolean
Inherited

Parameters

$name

string

Returns

boolean

Remove a single element

removeElement(string $name) : boolean
Inherited

Parameters

$name

string

Returns

boolean

Render display group

render(\Zend_View_Interface $view = null) : string
Inherited

Parameters

$view

Returns

string

Move pointer to beginning of element loop

rewind() : void
Inherited

Set group attribute

setAttrib(string $key, mixed $value) : \Zend_Form_DisplayGroup
Inherited

Parameters

$key

string

$value

mixed

Returns

\Zend_Form_DisplayGroup

Set multiple form attributes at once

setAttribs(array $attribs) : \Zend_Form_DisplayGroup
Inherited

Overwrites any previously set attributes.

Parameters

$attribs

array

Returns

\Zend_Form_DisplayGroup

Set options from config object

setConfig(\Zend_Config $config) : \Zend_Form_DisplayGroup
Inherited

Parameters

$config

\Zend_Config

Returns

\Zend_Form_DisplayGroup

Overwrite all decorators

setDecorators(array $decorators) : \Zend_Form_DisplayGroup
Inherited

Parameters

$decorators

array

Returns

\Zend_Form_DisplayGroup

Set description

setDescription(string $value) : \Zend_Form_DisplayGroup
Inherited

Parameters

$value

string

Returns

\Zend_Form_DisplayGroup

Set flag to disable loading default decorators

setDisableLoadDefaultDecorators(boolean $flag) : \Zend_Form_Element
Inherited

Parameters

$flag

boolean

Returns

\Zend_Form_Element

Indicate whether or not translation should be disabled

setDisableTranslator(boolean $flag) : \Zend_Form_DisplayGroup
Inherited

Parameters

$flag

boolean

Returns

\Zend_Form_DisplayGroup

Set multiple elements at once (overwrites)

setElements(array $elements) : \Zend_Form_DisplayGroup
Inherited

Parameters

$elements

array

Returns

\Zend_Form_DisplayGroup

Set form object to which the display group is attached

setForm(\Zend_Form $form) : \Zend_Form_DisplayGroup
Inherited

Parameters

$form

\Zend_Form

Returns

\Zend_Form_DisplayGroup

Set group legend

setLegend(string $legend) : \Zend_Form_DisplayGroup
Inherited

Parameters

$legend

string

Returns

\Zend_Form_DisplayGroup

Set group name

setName(string $name) : \Zend_Form_DisplayGroup
Inherited

Parameters

$name

string

Returns

\Zend_Form_DisplayGroup

Set options

setOptions(array $options) : \Zend_Form_DisplayGroup
Inherited

Parameters

$options

array

Returns

\Zend_Form_DisplayGroup

Set group order

setOrder(integer $order) : \Zend_Form_Element
Inherited

Parameters

$order

integer

Returns

\Zend_Form_Element

Set plugin loader

setPluginLoader(\Zend_Loader_PluginLoader $loader) : \Zend_Form_DisplayGroup
Inherited

Parameters

$loader

\Zend_Loader_PluginLoader

Returns

\Zend_Form_DisplayGroup

Set translator object

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

Parameters

$translator

\Zend_Translate\Zend_Translate_Adapternull

Returns

\Zend_Form_DisplayGroup

Set the view object

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

Ensures that the view object has the dojo view helper path set.

inherited_from \Zend_Form_DisplayGroup::setView()

Parameters

$view

\Zend_View_Interface

Returns

\Zend_Dojo_Form_Element_Dijit

Set view

setView(\Zend_View_Interface $view = null) : \Zend_Form_DisplayGroup
Inherited

Parameters

$view

\Zend_View_Interface

Returns

\Zend_Form_DisplayGroup

Is translation disabled?

translatorIsDisabled() : boolean
Inherited

Returns

boolean

Determine if current element/subform/display group is valid

valid() : boolean
Inherited

Returns

boolean

Instantiate a decorator based on class name or class name fragment

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

Parameters

$name

string

$options

nullarray

Returns

\Zend_Form_Decorator_Interface

Lazy-load a decorator

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

Parameters

$decorator

array

Decorator type and options

$name

mixed

Decorator name or alias

Returns

\Zend_Form_Decorator_Interface

Sort items according to their order

_sort() : void
Inherited

 Properties

 

Group attributes

$_attribs : array

Default

array()
 

Display group decorators

$_decorators : array

Default

array()
 

Description

$_description : string

Default

 

Should we disable loading the default decorators?

$_disableLoadDefaultDecorators : boolean

Default

false
 

Element order

$_elementOrder : array

Default

array()
 

Elements

$_elements : array

Default

array()
 

Form object to which the display group is currently registered

$_form : \Zend_Form

Default

 

Whether or not a new element has been added to the group

$_groupUpdated : boolean

Default

false
 

Plugin loader for decorators

$_loader : \Zend_Loader_PluginLoader

Default

 

Group name

$_name : string

Default

 

Group order

$_order : integer

Default

 

$_translator

$_translator : \Zend_Translate

Default

 

Is translation disabled?

$_translatorDisabled : boolean

Default

false
 

$_view

$_view : \Zend_View_Interface

Default