Dojo/Form/DisplayGroup.php

Show:

inherited

Classes
- \Zend_Dojo_Form_DisplayGroup

Table of Contents

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.

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
jump to top

Package: Zend\Dojo\Form

Dijit-enabled 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()

inherited

Group attributes

Inherited from: \Zend_Form_DisplayGroup::$$_attribs

Default valuearray()Details

Type: array
Inherited_from: \Zend_Form_DisplayGroup::$$_attribs

array $_decorators = array()

inherited

Display group decorators

Inherited from: \Zend_Form_DisplayGroup::$$_decorators

Default valuearray()Details

Type: array
Inherited_from: \Zend_Form_DisplayGroup::$$_decorators

string $_description

inherited

Description

Inherited from: \Zend_Form_DisplayGroup::$$_description

Details

Type: string
Inherited_from: \Zend_Form_DisplayGroup::$$_description

bool $_disableLoadDefaultDecorators = false

inherited

Should we disable loading the default decorators?

Inherited from: \Zend_Form_DisplayGroup::$$_disableLoadDefaultDecorators

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Form_DisplayGroup::$$_disableLoadDefaultDecorators

array $_elementOrder = array()

inherited

Element order

Inherited from: \Zend_Form_DisplayGroup::$$_elementOrder

Default valuearray()Details

Type: array
Inherited_from: \Zend_Form_DisplayGroup::$$_elementOrder

array $_elements = array()

inherited

Elements

Inherited from: \Zend_Form_DisplayGroup::$$_elements

Default valuearray()Details

Type: array
Inherited_from: \Zend_Form_DisplayGroup::$$_elements

\Zend_Form $_form

inherited

Form object to which the display group is currently registered

Inherited from: \Zend_Form_DisplayGroup::$$_form

Details

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

bool $_groupUpdated = false

inherited

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

Inherited from: \Zend_Form_DisplayGroup::$$_groupUpdated

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Form_DisplayGroup::$$_groupUpdated

\Zend_Loader_PluginLoader $_loader

inherited

Plugin loader for decorators

Inherited from: \Zend_Form_DisplayGroup::$$_loader

Details

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

string $_name

inherited

Group name

Inherited from: \Zend_Form_DisplayGroup::$$_name

Details

Type: string
Inherited_from: \Zend_Form_DisplayGroup::$$_name

int $_order

inherited

Group order

Inherited from: \Zend_Form_DisplayGroup::$$_order

Details

Type: int
Inherited_from: \Zend_Form_DisplayGroup::$$_order

\Zend_Translate $_translator

inherited

Inherited from: \Zend_Form_DisplayGroup::$$_translator

Details

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

bool $_translatorDisabled = false

inherited

Is translation disabled?

Inherited from: \Zend_Form_DisplayGroup::$$_translatorDisabled

Default valuefalseDetails

Type: bool
Inherited_from: \Zend_Form_DisplayGroup::$$_translatorDisabled

\Zend_View_Interface $_view

inherited

Inherited from: \Zend_Form_DisplayGroup::$$_view

Details

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

Methods

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

inherited

Overloading: allow rendering specific decorators

Inherited from: \Zend_Form_DisplayGroup::__call()

Call renderDecoratorName() to render a specific decorator.

Parameters

Name	Type	Description
$method	string
$args	array

Returns

Type	Description
string

Throws

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

Parameters

Name	Type	Description
$name	string
$loader	\Zend_Loader_PluginLoader
$options	array \| \Zend_Config \| null

__toString() : string

inherited

String representation of group

Inherited from: \Zend_Form_DisplayGroup::__toString()

Returns

Type	Description
string

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

inherited

Instantiate a decorator based on class name or class name fragment

Inherited from: \Zend_Form_DisplayGroup::_getDecorator()

Parameters

Name	Type	Description
$name	string
$options	null \| array

Returns

Type	Description
\Zend_Form_Decorator_Interface

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

inherited

Lazy-load a decorator

Inherited from: \Zend_Form_DisplayGroup::_loadDecorator()

Parameters

Name	Type	Description
$decorator	array	Decorator type and options
$name	mixed	Decorator name or alias

Returns

Type	Description
\Zend_Form_Decorator_Interface

_sort() : void

inherited

Sort items according to their order

Inherited from: \Zend_Form_DisplayGroup::_sort()

addAttribs(array $attribs) : \Zend_Form_DisplayGroup

inherited

Add multiple form attributes at once

Inherited from: \Zend_Form_DisplayGroup::addAttribs()

Parameters

Name	Type	Description
$attribs	array

Returns

Type	Description
\Zend_Form_DisplayGroup

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

inherited

Add a decorator for rendering the group

Inherited from: \Zend_Form_DisplayGroup::addDecorator()

Parameters

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

Returns

Type	Description
\Zend_Form_DisplayGroup

addDecorators(array $decorators) : \Zend_Form_DisplayGroup

inherited

Add many decorators at once

Inherited from: \Zend_Form_DisplayGroup::addDecorators()

Parameters

Name	Type	Description
$decorators	array

Returns

Type	Description
\Zend_Form_DisplayGroup

addElement(\Zend_Form_Element $element) : \Zend_Form_DisplayGroup

inherited

Add element to stack

Inherited from: \Zend_Form_DisplayGroup::addElement()

Parameters

Name	Type	Description
$element	\Zend_Form_Element

Returns

Type	Description
\Zend_Form_DisplayGroup

addElements(array $elements) : \Zend_Form_DisplayGroup

inherited

Add multiple elements at once

Inherited from: \Zend_Form_DisplayGroup::addElements()

Parameters

Name	Type	Description
$elements	array

Returns

Type	Description
\Zend_Form_DisplayGroup

Throws

Exception	Description
\Zend_Form_Exception	if any element is not a Zend_Form_Element

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

inherited

Add a prefix path for the plugin loader

Inherited from: \Zend_Form_DisplayGroup::addPrefixPath()

Parameters

Name	Type	Description
$prefix	string
$path	string

Returns

Type	Description
\Zend_Form_DisplayGroup

addPrefixPaths(array $spec) : \Zend_Form_DisplayGroup

inherited

Add several prefix paths at once

Inherited from: \Zend_Form_DisplayGroup::addPrefixPaths()

Parameters

Name	Type	Description
$spec	array

Returns

Type	Description
\Zend_Form_DisplayGroup

clearAttribs() : \Zend_Form

inherited

Clear all form attributes

Inherited from: \Zend_Form_DisplayGroup::clearAttribs()

Returns

Type	Description
\Zend_Form

clearDecorators() : \Zend_Form_DisplayGroup

inherited

Clear all decorators

Inherited from: \Zend_Form_DisplayGroup::clearDecorators()

Returns

Type	Description
\Zend_Form_DisplayGroup

clearElements() : \Zend_Form_DisplayGroup

inherited

Remove all elements

Inherited from: \Zend_Form_DisplayGroup::clearElements()

Returns

Type	Description
\Zend_Form_DisplayGroup

count() : int

inherited

Count of elements/subforms that are iterable

Inherited from: \Zend_Form_DisplayGroup::count()

Returns

Type	Description
int

current() : \Zend_Form_Element

inherited

Current element

Inherited from: \Zend_Form_DisplayGroup::current()

Returns

Type	Description
\Zend_Form_Element

filterName(string $value) : string

inherited

Filter a name to only allow valid variable characters

Inherited from: \Zend_Form_DisplayGroup::filterName()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
string

getAttrib(string $key) : mixed

inherited

Retrieve a single form attribute

Inherited from: \Zend_Form_DisplayGroup::getAttrib()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

getAttribs() : array

inherited

Retrieve all form attributes/metadata

Inherited from: \Zend_Form_DisplayGroup::getAttribs()

Returns

Type	Description
array

getDecorator(string $name) : false | \Zend_Form_Decorator_Abstract

inherited

Retrieve a registered decorator

Inherited from: \Zend_Form_DisplayGroup::getDecorator()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
false \| \Zend_Form_Decorator_Abstract

getDecorators() : array

inherited

Retrieve all decorators

Inherited from: \Zend_Form_DisplayGroup::getDecorators()

Returns

Type	Description
array

getDescription() : string

inherited

Get description

Inherited from: \Zend_Form_DisplayGroup::getDescription()

Returns

Type	Description
string

getElement(string $name) : \Zend_Form_Element | null

inherited

Retrieve element

Inherited from: \Zend_Form_DisplayGroup::getElement()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Form_Element \| null

getElements() : array

inherited

Retrieve elements

Inherited from: \Zend_Form_DisplayGroup::getElements()

Returns

Type	Description
array

getForm() : \Zend_Form | null

inherited

Get form object to which the group is attached

Inherited from: \Zend_Form_DisplayGroup::getForm()

Returns

Type	Description
\Zend_Form \| null

getFullyQualifiedName() : string

inherited

Get fully qualified name

Inherited from: \Zend_Form_DisplayGroup::getFullyQualifiedName()

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

Returns

Type	Description
string

getId() : string

inherited

Get element id

Inherited from: \Zend_Form_DisplayGroup::getId()

Returns

Type	Description
string

getLegend() : string

inherited

Retrieve group legend

Inherited from: \Zend_Form_DisplayGroup::getLegend()

Returns

Type	Description
string

getName() : string

inherited

Retrieve group name

Inherited from: \Zend_Form_DisplayGroup::getName()

Returns

Type	Description
string

getOrder() : int

inherited

Retrieve group order

Inherited from: \Zend_Form_DisplayGroup::getOrder()

Returns

Type	Description
int

getPluginLoader() : \Zend_Loader_PluginLoader

inherited

Retrieve plugin loader

Inherited from: \Zend_Form_DisplayGroup::getPluginLoader()

Returns

Type	Description
\Zend_Loader_PluginLoader

getTranslator() : \Zend_Translate_Adapter | null

inherited

Retrieve translator object

Inherited from: \Zend_Form_DisplayGroup::getTranslator()

Returns

Type	Description
\Zend_Translate_Adapter \| null

getView() : \Zend_View_Interface

inherited

Retrieve view

Inherited from: \Zend_Form_DisplayGroup::getView()

Returns

Type	Description
\Zend_View_Interface

hasTranslator() : bool

inherited

Does this display group have its own specific translator?

Inherited from: \Zend_Form_DisplayGroup::hasTranslator()

Returns

Type	Description
bool

init() : void

inherited

Initialize object; used by extending classes

Inherited from: \Zend_Form_DisplayGroup::init()

key() : string

inherited

Current element

Inherited from: \Zend_Form_DisplayGroup::key()

Returns

Type	Description
string

loadDefaultDecorators() : \Zend_Form_DisplayGroup

inherited

Load default decorators

Inherited from: \Zend_Form_DisplayGroup::loadDefaultDecorators()

Returns

Type	Description
\Zend_Form_DisplayGroup

loadDefaultDecoratorsIsDisabled() : bool

inherited

Should we load the default decorators?

Inherited from: \Zend_Form_DisplayGroup::loadDefaultDecoratorsIsDisabled()

Returns

Type	Description
bool

next() : void

inherited

Move pointer to next element

Inherited from: \Zend_Form_DisplayGroup::next()

removeAttrib(string $key) : bool

inherited

Remove attribute

Inherited from: \Zend_Form_DisplayGroup::removeAttrib()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
bool

removeDecorator(string $name) : bool

inherited

Remove a single decorator

Inherited from: \Zend_Form_DisplayGroup::removeDecorator()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
bool

removeElement(string $name) : boolean

inherited

Remove a single element

Inherited from: \Zend_Form_DisplayGroup::removeElement()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
boolean

render( $view = null) : string

inherited

Render display group

Inherited from: \Zend_Form_DisplayGroup::render()

Parameters

Name	Type	Description
$view

Returns

Type	Description
string

rewind() : void

inherited

Move pointer to beginning of element loop

Inherited from: \Zend_Form_DisplayGroup::rewind()

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

inherited

Set group attribute

Inherited from: \Zend_Form_DisplayGroup::setAttrib()

Parameters

Name	Type	Description
$key	string
$value	mixed

Returns

Type	Description
\Zend_Form_DisplayGroup

setAttribs(array $attribs) : \Zend_Form_DisplayGroup

inherited

Set multiple form attributes at once

Inherited from: \Zend_Form_DisplayGroup::setAttribs()

Overwrites any previously set attributes.

Parameters

Name	Type	Description
$attribs	array

Returns

Type	Description
\Zend_Form_DisplayGroup

setConfig(\Zend_Config $config) : \Zend_Form_DisplayGroup

inherited

Set options from config object

Inherited from: \Zend_Form_DisplayGroup::setConfig()

Parameters

Name	Type	Description
$config	\Zend_Config

Returns

Type	Description
\Zend_Form_DisplayGroup

setDecorators(array $decorators) : \Zend_Form_DisplayGroup

inherited

Overwrite all decorators

Inherited from: \Zend_Form_DisplayGroup::setDecorators()

Parameters

Name	Type	Description
$decorators	array

Returns

Type	Description
\Zend_Form_DisplayGroup

setDescription(string $value) : \Zend_Form_DisplayGroup

inherited

Set description

Inherited from: \Zend_Form_DisplayGroup::setDescription()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Form_DisplayGroup

setDisableLoadDefaultDecorators(bool $flag) : \Zend_Form_Element

inherited

Set flag to disable loading default decorators

Inherited from: \Zend_Form_DisplayGroup::setDisableLoadDefaultDecorators()

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Form_Element

setDisableTranslator(bool $flag) : \Zend_Form_DisplayGroup

inherited

Indicate whether or not translation should be disabled

Inherited from: \Zend_Form_DisplayGroup::setDisableTranslator()

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Form_DisplayGroup

setElements(array $elements) : \Zend_Form_DisplayGroup

inherited

Set multiple elements at once (overwrites)

Inherited from: \Zend_Form_DisplayGroup::setElements()

Parameters

Name	Type	Description
$elements	array

Returns

Type	Description
\Zend_Form_DisplayGroup

setForm(\Zend_Form $form) : \Zend_Form_DisplayGroup

inherited

Set form object to which the display group is attached

Inherited from: \Zend_Form_DisplayGroup::setForm()

Parameters

Name	Type	Description
$form	\Zend_Form

Returns

Type	Description
\Zend_Form_DisplayGroup

setLegend(string $legend) : \Zend_Form_DisplayGroup

inherited

Set group legend

Inherited from: \Zend_Form_DisplayGroup::setLegend()

Parameters

Name	Type	Description
$legend	string

Returns

Type	Description
\Zend_Form_DisplayGroup

setName(string $name) : \Zend_Form_DisplayGroup

inherited

Set group name

Inherited from: \Zend_Form_DisplayGroup::setName()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Form_DisplayGroup

setOptions(array $options) : \Zend_Form_DisplayGroup

inherited

Set options

Inherited from: \Zend_Form_DisplayGroup::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Form_DisplayGroup

setOrder(int $order) : \Zend_Form_Element

inherited

Set group order

Inherited from: \Zend_Form_DisplayGroup::setOrder()

Parameters

Name	Type	Description
$order	int

Returns

Type	Description
\Zend_Form_Element

setPluginLoader(\Zend_Loader_PluginLoader $loader) : \Zend_Form_DisplayGroup

inherited

Set plugin loader

Inherited from: \Zend_Form_DisplayGroup::setPluginLoader()

Parameters

Name	Type	Description
$loader	\Zend_Loader_PluginLoader

Returns

Type	Description
\Zend_Form_DisplayGroup

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

inherited

Set translator object

Inherited from: \Zend_Form_DisplayGroup::setTranslator()

Parameters

Name	Type	Description
$translator	\Zend_Translate \| \Zend_Translate_Adapter \| null

Returns

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.

Parameters

Name	Type	Description
$view	\Zend_View_Interface

Returns

Type	Description
\Zend_Dojo_Form_Element_Dijit

translatorIsDisabled() : bool

inherited

Is translation disabled?

Inherited from: \Zend_Form_DisplayGroup::translatorIsDisabled()

Returns

Type	Description
bool

valid() : bool

inherited

Determine if current element/subform/display group is valid

Inherited from: \Zend_Form_DisplayGroup::valid()

Returns

Type	Description
bool

Dojo/Form/DisplayGroup.php

\Zend_Dojo_Form_DisplayGroupjump to top

Properties

Methods

\Zend_Dojo_Form_DisplayGroup
jump to top