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.
Dijit-enabled DisplayGroup

__call(
string $method, array $args
)
:
string
Overloading: allow rendering specific decorators
Inherited from: \Zend_Form_DisplayGroup::__call()Call renderDecoratorName() to render a specific decorator.
Name | Type | Description |
---|---|---|
$method | string | |
$args | array |
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Form_Exception | for invalid decorator or invalid method call |

__construct(
string $name, \Zend_Loader_PluginLoader $loader, array|\Zend_Config|null $options
=
null
)
:
void
Constructor
Name | Type | Description |
---|---|---|
$name | string | |
$loader | \Zend_Loader_PluginLoader | |
$options | array|\Zend_Config|null |

__toString(
)
:
string
String representation of group
Inherited from: \Zend_Form_DisplayGroup::__toString()Type | Description |
---|---|
string |

_getDecorator(
string $name, null|array $options
=
null
)
:
\Zend_Form_Decorator_Interface
Instantiate a decorator based on class name or class name fragment
Inherited from: \Zend_Form_DisplayGroup::_getDecorator()Name | Type | Description |
---|---|---|
$name | string | |
$options | null|array |
Type | Description |
---|---|
\Zend_Form_Decorator_Interface |

_loadDecorator(
array $decorator, mixed $name
)
:
\Zend_Form_Decorator_Interface
Lazy-load a decorator
Inherited from: \Zend_Form_DisplayGroup::_loadDecorator()Name | Type | Description |
---|---|---|
$decorator | array | Decorator type and options |
$name | mixed | Decorator name or alias |
Type | Description |
---|---|
\Zend_Form_Decorator_Interface |

_sort(
)
:
void
Sort items according to their order
Inherited from: \Zend_Form_DisplayGroup::_sort()
addAttribs(
array $attribs
)
:
\Zend_Form_DisplayGroup
Add multiple form attributes at once
Inherited from: \Zend_Form_DisplayGroup::addAttribs()
addDecorator(
string|\Zend_Form_Decorator_Interface $decorator, array|\Zend_Config $options
=
null
)
:
\Zend_Form_DisplayGroup
Add a decorator for rendering the group
Inherited from: \Zend_Form_DisplayGroup::addDecorator()Name | Type | Description |
---|---|---|
$decorator | string|\Zend_Form_Decorator_Interface | |
$options | array|\Zend_Config | Options with which to initialize decorator |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |

addDecorators(
array $decorators
)
:
\Zend_Form_DisplayGroup
Add many decorators at once
Inherited from: \Zend_Form_DisplayGroup::addDecorators()
addElement(
\Zend_Form_Element $element
)
:
\Zend_Form_DisplayGroup
Add element to stack
Inherited from: \Zend_Form_DisplayGroup::addElement()Name | Type | Description |
---|---|---|
$element | \Zend_Form_Element |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |

addElements(
array $elements
)
:
\Zend_Form_DisplayGroup
Add multiple elements at once
Inherited from: \Zend_Form_DisplayGroup::addElements()Name | Type | Description |
---|---|---|
$elements | array |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |
Exception | Description |
---|---|
\Zend_Form_Exception | if any element is not a Zend_Form_Element |

addPrefixPath(
string $prefix, string $path
)
:
\Zend_Form_DisplayGroup
Add a prefix path for the plugin loader
Inherited from: \Zend_Form_DisplayGroup::addPrefixPath()Name | Type | Description |
---|---|---|
$prefix | string | |
$path | string |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |

addPrefixPaths(
array $spec
)
:
\Zend_Form_DisplayGroup
Add several prefix paths at once
Inherited from: \Zend_Form_DisplayGroup::addPrefixPaths()
clearAttribs(
)
:
\Zend_Form
Clear all form attributes
Inherited from: \Zend_Form_DisplayGroup::clearAttribs()Type | Description |
---|---|
\Zend_Form |

clearDecorators(
)
:
\Zend_Form_DisplayGroup
Clear all decorators
Inherited from: \Zend_Form_DisplayGroup::clearDecorators()Type | Description |
---|---|
\Zend_Form_DisplayGroup |

clearElements(
)
:
\Zend_Form_DisplayGroup
Remove all elements
Inherited from: \Zend_Form_DisplayGroup::clearElements()Type | Description |
---|---|
\Zend_Form_DisplayGroup |

count(
)
:
int
Count of elements/subforms that are iterable
Inherited from: \Zend_Form_DisplayGroup::count()Type | Description |
---|---|
int |

current(
)
:
\Zend_Form_Element
Current element
Inherited from: \Zend_Form_DisplayGroup::current()Type | Description |
---|---|
\Zend_Form_Element |

filterName(
string $value
)
:
string
Filter a name to only allow valid variable characters
Inherited from: \Zend_Form_DisplayGroup::filterName()Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
string |

getAttrib(
string $key
)
:
mixed
Retrieve a single form attribute
Inherited from: \Zend_Form_DisplayGroup::getAttrib()Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |

getAttribs(
)
:
array
Retrieve all form attributes/metadata
Inherited from: \Zend_Form_DisplayGroup::getAttribs()Type | Description |
---|---|
array |

getDecorator(
string $name
)
:
false|\Zend_Form_Decorator_Abstract
Retrieve a registered decorator
Inherited from: \Zend_Form_DisplayGroup::getDecorator()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
false\Zend_Form_Decorator_Abstract |

getDecorators(
)
:
array
Retrieve all decorators
Inherited from: \Zend_Form_DisplayGroup::getDecorators()Type | Description |
---|---|
array |

getDescription(
)
:
string
Get description
Inherited from: \Zend_Form_DisplayGroup::getDescription()Type | Description |
---|---|
string |

getElement(
string $name
)
:
\Zend_Form_Element|null
Retrieve element
Inherited from: \Zend_Form_DisplayGroup::getElement()
getElements(
)
:
array
Retrieve elements
Inherited from: \Zend_Form_DisplayGroup::getElements()Type | Description |
---|---|
array |

getForm(
)
:
\Zend_Form|null
Get form object to which the group is attached
Inherited from: \Zend_Form_DisplayGroup::getForm()Type | Description |
---|---|
\Zend_Formnull |

getFullyQualifiedName(
)
:
string
Get fully qualified name
Inherited from: \Zend_Form_DisplayGroup::getFullyQualifiedName()Places name as subitem of array and/or appends brackets.
Type | Description |
---|---|
string |

getId(
)
:
string
Get element id
Inherited from: \Zend_Form_DisplayGroup::getId()Type | Description |
---|---|
string |

getLegend(
)
:
string
Retrieve group legend
Inherited from: \Zend_Form_DisplayGroup::getLegend()Type | Description |
---|---|
string |

getName(
)
:
string
Retrieve group name
Inherited from: \Zend_Form_DisplayGroup::getName()Type | Description |
---|---|
string |

getOrder(
)
:
int
Retrieve group order
Inherited from: \Zend_Form_DisplayGroup::getOrder()Type | Description |
---|---|
int |

getPluginLoader(
)
:
\Zend_Loader_PluginLoader
Retrieve plugin loader
Inherited from: \Zend_Form_DisplayGroup::getPluginLoader()Type | Description |
---|---|
\Zend_Loader_PluginLoader |

getTranslator(
)
:
\Zend_Translate_Adapter|null
Retrieve translator object
Inherited from: \Zend_Form_DisplayGroup::getTranslator()Type | Description |
---|---|
\Zend_Translate_Adapternull |

getView(
)
:
\Zend_View_Interface
Retrieve view
Inherited from: \Zend_Form_DisplayGroup::getView()Type | Description |
---|---|
\Zend_View_Interface |

init(
)
:
void
Initialize object; used by extending classes
Inherited from: \Zend_Form_DisplayGroup::init()
key(
)
:
string
Current element
Inherited from: \Zend_Form_DisplayGroup::key()Type | Description |
---|---|
string |

loadDefaultDecorators(
)
:
\Zend_Form_DisplayGroup
Load default decorators
Inherited from: \Zend_Form_DisplayGroup::loadDefaultDecorators()Type | Description |
---|---|
\Zend_Form_DisplayGroup |

loadDefaultDecoratorsIsDisabled(
)
:
bool
Should we load the default decorators?
Inherited from: \Zend_Form_DisplayGroup::loadDefaultDecoratorsIsDisabled()Type | Description |
---|---|
bool |

removeAttrib(
string $key
)
:
bool
Remove attribute
Inherited from: \Zend_Form_DisplayGroup::removeAttrib()Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
bool |

removeDecorator(
string $name
)
:
bool
Remove a single decorator
Inherited from: \Zend_Form_DisplayGroup::removeDecorator()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
bool |

removeElement(
string $name
)
:
boolean
Remove a single element
Inherited from: \Zend_Form_DisplayGroup::removeElement()Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
boolean |

render(
$view
=
null
)
:
string
Render display group
Inherited from: \Zend_Form_DisplayGroup::render()Name | Type | Description |
---|---|---|
$view |
Type | Description |
---|---|
string |

rewind(
)
:
void
Move pointer to beginning of element loop
Inherited from: \Zend_Form_DisplayGroup::rewind()
setAttrib(
string $key, mixed $value
)
:
\Zend_Form_DisplayGroup
Set group attribute
Inherited from: \Zend_Form_DisplayGroup::setAttrib()Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |

setAttribs(
array $attribs
)
:
\Zend_Form_DisplayGroup
Set multiple form attributes at once
Inherited from: \Zend_Form_DisplayGroup::setAttribs()Overwrites any previously set attributes.
Name | Type | Description |
---|---|---|
$attribs | array |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |

setConfig(
\Zend_Config $config
)
:
\Zend_Form_DisplayGroup
Set options from config object
Inherited from: \Zend_Form_DisplayGroup::setConfig()Name | Type | Description |
---|---|---|
$config | \Zend_Config |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |

setDecorators(
array $decorators
)
:
\Zend_Form_DisplayGroup
Overwrite all decorators
Inherited from: \Zend_Form_DisplayGroup::setDecorators()
setDescription(
string $value
)
:
\Zend_Form_DisplayGroup
Set description
Inherited from: \Zend_Form_DisplayGroup::setDescription()
setDisableLoadDefaultDecorators(
bool $flag
)
:
\Zend_Form_Element
Set flag to disable loading default decorators
Inherited from: \Zend_Form_DisplayGroup::setDisableLoadDefaultDecorators()
setDisableTranslator(
bool $flag
)
:
\Zend_Form_DisplayGroup
Indicate whether or not translation should be disabled
Inherited from: \Zend_Form_DisplayGroup::setDisableTranslator()
setElements(
array $elements
)
:
\Zend_Form_DisplayGroup
Set multiple elements at once (overwrites)
Inherited from: \Zend_Form_DisplayGroup::setElements()
setForm(
\Zend_Form $form
)
:
\Zend_Form_DisplayGroup
Set form object to which the display group is attached
Inherited from: \Zend_Form_DisplayGroup::setForm()
setLegend(
string $legend
)
:
\Zend_Form_DisplayGroup
Set group legend
Inherited from: \Zend_Form_DisplayGroup::setLegend()
setName(
string $name
)
:
\Zend_Form_DisplayGroup
Set group name
Inherited from: \Zend_Form_DisplayGroup::setName()
setOptions(
array $options
)
:
\Zend_Form_DisplayGroup
Set options
Inherited from: \Zend_Form_DisplayGroup::setOptions()
setOrder(
int $order
)
:
\Zend_Form_Element
Set group order
Inherited from: \Zend_Form_DisplayGroup::setOrder()
setPluginLoader(
\Zend_Loader_PluginLoader $loader
)
:
\Zend_Form_DisplayGroup
Set plugin loader
Inherited from: \Zend_Form_DisplayGroup::setPluginLoader()Name | Type | Description |
---|---|---|
$loader | \Zend_Loader_PluginLoader |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |

setTranslator(
\Zend_Translate|\Zend_Translate_Adapter|null $translator
=
null
)
:
\Zend_Form_DisplayGroup
Set translator object
Inherited from: \Zend_Form_DisplayGroup::setTranslator()Name | Type | Description |
---|---|---|
$translator | \Zend_Translate|\Zend_Translate_Adapter|null |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |

setView(
\Zend_View_Interface $view
=
null
)
:
\Zend_Dojo_Form_Element_Dijit
Set the view object
Ensures that the view object has the dojo view helper path set.
Name | Type | Description |
---|---|---|
$view | \Zend_View_Interface |
Type | Description |
---|---|
\Zend_Dojo_Form_Element_Dijit |

translatorIsDisabled(
)
:
bool
Is translation disabled?
Inherited from: \Zend_Form_DisplayGroup::translatorIsDisabled()Type | Description |
---|---|
bool |

valid(
)
:
bool
Determine if current element/subform/display group is valid
Inherited from: \Zend_Form_DisplayGroup::valid()Type | Description |
---|---|
bool |