Dojo/Form/DisplayGroup.php
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Dojo
- Subpackage
- Form
\Zend_Dojo_Form_DisplayGroup
- Parent(s)
- \Zend_Form_DisplayGroup
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Uses
- \global\Zend_Form_DisplayGroup
- Version
- $Id: DisplayGroup.php 24593 2012-01-05 20:35:02Z matthew $
Properties


array $_attribs = array()
array()
Details- Type
- array
- Inherited_from
- \Zend_Form_DisplayGroup::$$_attribs


array $_decorators = array()
array()
Details- Type
- array
- Inherited_from
- \Zend_Form_DisplayGroup::$$_decorators


bool $_disableLoadDefaultDecorators = false
false
Details- Type
- bool
- Inherited_from
- \Zend_Form_DisplayGroup::$$_disableLoadDefaultDecorators


array $_elementOrder = array()
array()
Details- Type
- array
- Inherited_from
- \Zend_Form_DisplayGroup::$$_elementOrder


array $_elements = array()
array()
Details- Type
- array
- Inherited_from
- \Zend_Form_DisplayGroup::$$_elements


\Zend_Form $_form
- Type
- \Zend_Form
- Inherited_from
- \Zend_Form_DisplayGroup::$$_form


bool $_groupUpdated = false
false
Details- Type
- bool
- Inherited_from
- \Zend_Form_DisplayGroup::$$_groupUpdated


\Zend_Loader_PluginLoader $_loader
- Type
- \Zend_Loader_PluginLoader
- Inherited_from
- \Zend_Form_DisplayGroup::$$_loader


\Zend_Translate $_translator
- Type
- \Zend_Translate
- Inherited_from
- \Zend_Form_DisplayGroup::$$_translator


bool $_translatorDisabled = false
false
Details- Type
- bool
- Inherited_from
- \Zend_Form_DisplayGroup::$$_translatorDisabled


\Zend_View_Interface $_view
- Type
- \Zend_View_Interface
- Inherited_from
- \Zend_Form_DisplayGroup::$$_view
Methods


__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 |


_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
Name | Type | Description |
---|---|---|
$decorator | array | Decorator type and options |
$name | mixed | Decorator name or alias |
Type | Description |
---|---|
\Zend_Form_Decorator_Interface |


addAttribs(array $attribs) : \Zend_Form_DisplayGroup
Name | Type | Description |
---|---|---|
$attribs | array |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |


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
Name | Type | Description |
---|---|---|
$decorators | array |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |


addElement(\Zend_Form_Element $element) : \Zend_Form_DisplayGroup
Name | Type | Description |
---|---|---|
$element | \Zend_Form_Element |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |


addElements(array $elements) : \Zend_Form_DisplayGroup
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
Name | Type | Description |
---|---|---|
$spec | array |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |


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


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 |


getDecorator(string $name) : false | \Zend_Form_Decorator_Abstract
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
false | \Zend_Form_Decorator_Abstract |


getElement(string $name) : \Zend_Form_Element | null
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
\Zend_Form_Element | null |


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


getFullyQualifiedName() : string
Places name as subitem of array and/or appends brackets.
Type | Description |
---|---|
string |


getTranslator() : \Zend_Translate_Adapter | null
Type | Description |
---|---|
\Zend_Translate_Adapter | null |


hasTranslator() : bool
Does this display group have its own specific translator?
Inherited from: \Zend_Form_DisplayGroup::hasTranslator()Type | Description |
---|---|
bool |


init() : void
Initialize object; used by extending classes
Inherited from: \Zend_Form_DisplayGroup::init()

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


removeDecorator(string $name) : bool
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
bool |


removeElement(string $name) : boolean
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
boolean |


setAttrib(string $key, mixed $value) : \Zend_Form_DisplayGroup
Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |


setAttribs(array $attribs) : \Zend_Form_DisplayGroup
Overwrites any previously set attributes.
Name | Type | Description |
---|---|---|
$attribs | array |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |


setConfig(\Zend_Config $config) : \Zend_Form_DisplayGroup
Name | Type | Description |
---|---|---|
$config | \Zend_Config |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |


setDecorators(array $decorators) : \Zend_Form_DisplayGroup
Name | Type | Description |
---|---|---|
$decorators | array |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |


setDescription(string $value) : \Zend_Form_DisplayGroup
Name | Type | Description |
---|---|---|
$value | string |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |


setDisableLoadDefaultDecorators(bool $flag) : \Zend_Form_Element
Set flag to disable loading default decorators
Inherited from: \Zend_Form_DisplayGroup::setDisableLoadDefaultDecorators()Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Form_Element |


setDisableTranslator(bool $flag) : \Zend_Form_DisplayGroup
Indicate whether or not translation should be disabled
Inherited from: \Zend_Form_DisplayGroup::setDisableTranslator()Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |


setElements(array $elements) : \Zend_Form_DisplayGroup
Set multiple elements at once (overwrites)
Inherited from: \Zend_Form_DisplayGroup::setElements()Name | Type | Description |
---|---|---|
$elements | array |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |


setForm(\Zend_Form $form) : \Zend_Form_DisplayGroup
Set form object to which the display group is attached
Inherited from: \Zend_Form_DisplayGroup::setForm()Name | Type | Description |
---|---|---|
$form | \Zend_Form |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |


setLegend(string $legend) : \Zend_Form_DisplayGroup
Name | Type | Description |
---|---|---|
$legend | string |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |


setName(string $name) : \Zend_Form_DisplayGroup
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |


setOptions(array $options) : \Zend_Form_DisplayGroup
Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |


setOrder(int $order) : \Zend_Form_Element
Name | Type | Description |
---|---|---|
$order | int |
Type | Description |
---|---|
\Zend_Form_Element |


setPluginLoader(\Zend_Loader_PluginLoader $loader) : \Zend_Form_DisplayGroup
Name | Type | Description |
---|---|---|
$loader | \Zend_Loader_PluginLoader |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |


setTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : \Zend_Form_DisplayGroup
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 |


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