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.
Zend_Form_DisplayGroup

bool
$_disableLoadDefaultDecorators= 'false'
Should we disable loading the default decorators?
false
Details
\Zend_Form
$_form= ''
Form object to which the display group is currently registered

bool
$_groupUpdated= 'false'
Whether or not a new element has been added to the group
false
Details
__call(
string $method, array $args
)
:
string
Overloading: allow rendering specific decorators
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 $options
=
null
)
:
void
Constructor
Name | Type | Description |
---|---|---|
$name | string | |
$loader | \Zend_Loader_PluginLoader | |
$options | array|\Zend_Config |

_getDecorator(
string $name, null|array $options
=
null
)
:
\Zend_Form_Decorator_Interface
Instantiate a decorator based on class name or class name fragment
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
Name | Type | Description |
---|---|---|
$decorator | array | Decorator type and options |
$name | mixed | Decorator name or alias |
Type | Description |
---|---|
\Zend_Form_Decorator_Interface |

addDecorator(
string|\Zend_Form_Decorator_Interface $decorator, array|\Zend_Config $options
=
null
)
:
\Zend_Form_DisplayGroup
Add a decorator for rendering the group
Name | Type | Description |
---|---|---|
$decorator | string|\Zend_Form_Decorator_Interface | |
$options | array|\Zend_Config | Options with which to initialize decorator |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |

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

addElements(
array $elements
)
:
\Zend_Form_DisplayGroup
Add multiple elements at once
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
Name | Type | Description |
---|---|---|
$prefix | string | |
$path | string |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |

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

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

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

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

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

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

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

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

getTranslator(
)
:
\Zend_Translate_Adapter|null
Retrieve translator object
Type | Description |
---|---|
\Zend_Translate_Adapter|null |

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

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

removeAttrib(
string $key
)
:
bool
Remove attribute
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
bool |

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

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

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

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

setAttribs(
array $attribs
)
:
\Zend_Form_DisplayGroup
Set multiple form attributes at once
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
Name | Type | Description |
---|---|---|
$config | \Zend_Config |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |

setDisableLoadDefaultDecorators(
bool $flag
)
:
\Zend_Form_Element
Set flag to disable loading default decorators

setDisableTranslator(
bool $flag
)
:
\Zend_Form_DisplayGroup
Indicate whether or not translation should be disabled

setForm(
\Zend_Form $form
)
:
\Zend_Form_DisplayGroup
Set form object to which the display group is attached

setPluginLoader(
\Zend_Loader_PluginLoader $loader
)
:
\Zend_Form_DisplayGroup
Set plugin loader
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
Name | Type | Description |
---|---|---|
$translator | \Zend_Translate|\Zend_Translate_Adapter|null |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |

setView(
\Zend_View_Interface $view
=
null
)
:
\Zend_Form_DisplayGroup
Set view
Name | Type | Description |
---|---|---|
$view | \Zend_View_Interface |
Type | Description |
---|---|
\Zend_Form_DisplayGroup |