Dojo/Form/DisplayGroup.php

Show: PublicProtectedPrivateinherited
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

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

>VPropertyprotectedarray $_attribs = array()
inherited
Group attributes
Inherited from: \Zend_Form_DisplayGroup::$$_attribs
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_DisplayGroup::$$_attribs  
>VPropertyprotectedarray $_decorators = array()
inherited
Display group decorators
Inherited from: \Zend_Form_DisplayGroup::$$_decorators
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_DisplayGroup::$$_decorators  
>VPropertyprotectedstring $_description
inherited
Description
Inherited from: \Zend_Form_DisplayGroup::$$_description
Details
Type
string
Inherited_from
\Zend_Form_DisplayGroup::$$_description  
>VPropertyprotectedbool $_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  
>VPropertyprotectedarray $_elementOrder = array()
inherited
Element order
Inherited from: \Zend_Form_DisplayGroup::$$_elementOrder
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_DisplayGroup::$$_elementOrder  
>VPropertyprotectedarray $_elements = array()
inherited
Elements
Inherited from: \Zend_Form_DisplayGroup::$$_elements
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_DisplayGroup::$$_elements  
>VPropertyprotected\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  
>VPropertyprotectedbool $_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  
>VPropertyprotected\Zend_Loader_PluginLoader $_loader
inherited
Plugin loader for decorators
Inherited from: \Zend_Form_DisplayGroup::$$_loader
>VPropertyprotectedstring $_name
inherited
Group name
Inherited from: \Zend_Form_DisplayGroup::$$_name
Details
Type
string
Inherited_from
\Zend_Form_DisplayGroup::$$_name  
>VPropertyprotectedint $_order
inherited
Group order
Inherited from: \Zend_Form_DisplayGroup::$$_order
Details
Type
int
Inherited_from
\Zend_Form_DisplayGroup::$$_order  
>VPropertyprotected\Zend_Translate $_translator
>VPropertyprotectedbool $_translatorDisabled = false
inherited
Is translation disabled?
Inherited from: \Zend_Form_DisplayGroup::$$_translatorDisabled
Default valuefalseDetails
Type
bool
Inherited_from
\Zend_Form_DisplayGroup::$$_translatorDisabled  
>VPropertyprotected\Zend_View_Interface $_view
inherited
Inherited from: \Zend_Form_DisplayGroup::$$_view

Methods

methodpublic__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
NameTypeDescription
$methodstring
$argsarray
Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Form_Exceptionfor invalid decorator or invalid method call
methodpublic__construct(string $name, \Zend_Loader_PluginLoader $loader, array | \Zend_Config | null $options = null) : void

Constructor

Parameters
NameTypeDescription
$namestring
$loader\Zend_Loader_PluginLoader
$optionsarray | \Zend_Config | null
methodpublic__toString() : string
inherited

String representation of group

Inherited from: \Zend_Form_DisplayGroup::__toString()
Returns
TypeDescription
string
methodprotected_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
NameTypeDescription
$namestring
$optionsnull | array
Returns
TypeDescription
\Zend_Form_Decorator_Interface
methodprotected_loadDecorator(array $decorator, mixed $name) : \Zend_Form_Decorator_Interface
inherited

Lazy-load a decorator

Inherited from: \Zend_Form_DisplayGroup::_loadDecorator()
Parameters
NameTypeDescription
$decoratorarray

Decorator type and options

$namemixed

Decorator name or alias

Returns
TypeDescription
\Zend_Form_Decorator_Interface
methodprotected_sort() : void
inherited

Sort items according to their order

Inherited from: \Zend_Form_DisplayGroup::_sort()
methodpublicaddAttribs(array $attribs) : \Zend_Form_DisplayGroup
inherited

Add multiple form attributes at once

Inherited from: \Zend_Form_DisplayGroup::addAttribs()
Parameters
NameTypeDescription
$attribsarray
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicaddDecorator(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
NameTypeDescription
$decoratorstring | \Zend_Form_Decorator_Interface
$optionsarray | \Zend_Config

Options with which to initialize decorator

Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicaddDecorators(array $decorators) : \Zend_Form_DisplayGroup
inherited

Add many decorators at once

Inherited from: \Zend_Form_DisplayGroup::addDecorators()
Parameters
NameTypeDescription
$decoratorsarray
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicaddElement(\Zend_Form_Element $element) : \Zend_Form_DisplayGroup
inherited

Add element to stack

Inherited from: \Zend_Form_DisplayGroup::addElement()
Parameters
NameTypeDescription
$element\Zend_Form_Element
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicaddElements(array $elements) : \Zend_Form_DisplayGroup
inherited

Add multiple elements at once

Inherited from: \Zend_Form_DisplayGroup::addElements()
Parameters
NameTypeDescription
$elementsarray
Returns
TypeDescription
\Zend_Form_DisplayGroup
Throws
ExceptionDescription
\Zend_Form_Exceptionif any element is not a Zend_Form_Element
methodpublicaddPrefixPath(string $prefix, string $path) : \Zend_Form_DisplayGroup
inherited

Add a prefix path for the plugin loader

Inherited from: \Zend_Form_DisplayGroup::addPrefixPath()
Parameters
NameTypeDescription
$prefixstring
$pathstring
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicaddPrefixPaths(array $spec) : \Zend_Form_DisplayGroup
inherited

Add several prefix paths at once

Inherited from: \Zend_Form_DisplayGroup::addPrefixPaths()
Parameters
NameTypeDescription
$specarray
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicclearAttribs() : \Zend_Form
inherited

Clear all form attributes

Inherited from: \Zend_Form_DisplayGroup::clearAttribs()
Returns
TypeDescription
\Zend_Form
methodpublicclearDecorators() : \Zend_Form_DisplayGroup
inherited

Clear all decorators

Inherited from: \Zend_Form_DisplayGroup::clearDecorators()
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicclearElements() : \Zend_Form_DisplayGroup
inherited

Remove all elements

Inherited from: \Zend_Form_DisplayGroup::clearElements()
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpubliccount() : int
inherited

Count of elements/subforms that are iterable

Inherited from: \Zend_Form_DisplayGroup::count()
Returns
TypeDescription
int
methodpubliccurrent() : \Zend_Form_Element
inherited

Current element

Inherited from: \Zend_Form_DisplayGroup::current()
Returns
TypeDescription
\Zend_Form_Element
methodpublicfilterName(string $value) : string
inherited

Filter a name to only allow valid variable characters

Inherited from: \Zend_Form_DisplayGroup::filterName()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
string
methodpublicgetAttrib(string $key) : mixed
inherited

Retrieve a single form attribute

Inherited from: \Zend_Form_DisplayGroup::getAttrib()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublicgetAttribs() : array
inherited

Retrieve all form attributes/metadata

Inherited from: \Zend_Form_DisplayGroup::getAttribs()
Returns
TypeDescription
array
methodpublicgetDecorator(string $name) : false | \Zend_Form_Decorator_Abstract
inherited

Retrieve a registered decorator

Inherited from: \Zend_Form_DisplayGroup::getDecorator()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
false | \Zend_Form_Decorator_Abstract
methodpublicgetDecorators() : array
inherited

Retrieve all decorators

Inherited from: \Zend_Form_DisplayGroup::getDecorators()
Returns
TypeDescription
array
methodpublicgetDescription() : string
inherited

Get description

Inherited from: \Zend_Form_DisplayGroup::getDescription()
Returns
TypeDescription
string
methodpublicgetElement(string $name) : \Zend_Form_Element | null
inherited

Retrieve element

Inherited from: \Zend_Form_DisplayGroup::getElement()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_Form_Element | null
methodpublicgetElements() : array
inherited

Retrieve elements

Inherited from: \Zend_Form_DisplayGroup::getElements()
Returns
TypeDescription
array
methodpublicgetForm() : \Zend_Form | null
inherited

Get form object to which the group is attached

Inherited from: \Zend_Form_DisplayGroup::getForm()
Returns
TypeDescription
\Zend_Form | null
methodpublicgetFullyQualifiedName() : string
inherited

Get fully qualified name

Inherited from: \Zend_Form_DisplayGroup::getFullyQualifiedName()

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

Returns
TypeDescription
string
methodpublicgetId() : string
inherited

Get element id

Inherited from: \Zend_Form_DisplayGroup::getId()
Returns
TypeDescription
string
methodpublicgetLegend() : string
inherited

Retrieve group legend

Inherited from: \Zend_Form_DisplayGroup::getLegend()
Returns
TypeDescription
string
methodpublicgetName() : string
inherited

Retrieve group name

Inherited from: \Zend_Form_DisplayGroup::getName()
Returns
TypeDescription
string
methodpublicgetOrder() : int
inherited

Retrieve group order

Inherited from: \Zend_Form_DisplayGroup::getOrder()
Returns
TypeDescription
int
methodpublicgetPluginLoader() : \Zend_Loader_PluginLoader
inherited

Retrieve plugin loader

Inherited from: \Zend_Form_DisplayGroup::getPluginLoader()
Returns
TypeDescription
\Zend_Loader_PluginLoader
methodpublicgetTranslator() : \Zend_Translate_Adapter | null
inherited

Retrieve translator object

Inherited from: \Zend_Form_DisplayGroup::getTranslator()
Returns
TypeDescription
\Zend_Translate_Adapter | null
methodpublicgetView() : \Zend_View_Interface
inherited

Retrieve view

Inherited from: \Zend_Form_DisplayGroup::getView()
Returns
TypeDescription
\Zend_View_Interface
methodpublichasTranslator() : bool
inherited

Does this display group have its own specific translator?

Inherited from: \Zend_Form_DisplayGroup::hasTranslator()
Returns
TypeDescription
bool
methodpublicinit() : void
inherited

Initialize object; used by extending classes

Inherited from: \Zend_Form_DisplayGroup::init()
methodpublickey() : string
inherited

Current element

Inherited from: \Zend_Form_DisplayGroup::key()
Returns
TypeDescription
string
methodpublicloadDefaultDecorators() : \Zend_Form_DisplayGroup
inherited

Load default decorators

Inherited from: \Zend_Form_DisplayGroup::loadDefaultDecorators()
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicloadDefaultDecoratorsIsDisabled() : bool
inherited

Should we load the default decorators?

Inherited from: \Zend_Form_DisplayGroup::loadDefaultDecoratorsIsDisabled()
Returns
TypeDescription
bool
methodpublicnext() : void
inherited

Move pointer to next element

Inherited from: \Zend_Form_DisplayGroup::next()
methodpublicremoveAttrib(string $key) : bool
inherited

Remove attribute

Inherited from: \Zend_Form_DisplayGroup::removeAttrib()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
bool
methodpublicremoveDecorator(string $name) : bool
inherited

Remove a single decorator

Inherited from: \Zend_Form_DisplayGroup::removeDecorator()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
bool
methodpublicremoveElement(string $name) : boolean
inherited

Remove a single element

Inherited from: \Zend_Form_DisplayGroup::removeElement()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
boolean
methodpublicrender( $view = null) : string
inherited

Render display group

Inherited from: \Zend_Form_DisplayGroup::render()
Parameters
NameTypeDescription
$view
Returns
TypeDescription
string
methodpublicrewind() : void
inherited

Move pointer to beginning of element loop

Inherited from: \Zend_Form_DisplayGroup::rewind()
methodpublicsetAttrib(string $key, mixed $value) : \Zend_Form_DisplayGroup
inherited

Set group attribute

Inherited from: \Zend_Form_DisplayGroup::setAttrib()
Parameters
NameTypeDescription
$keystring
$valuemixed
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicsetAttribs(array $attribs) : \Zend_Form_DisplayGroup
inherited

Set multiple form attributes at once

Inherited from: \Zend_Form_DisplayGroup::setAttribs()

Overwrites any previously set attributes.

Parameters
NameTypeDescription
$attribsarray
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicsetConfig(\Zend_Config $config) : \Zend_Form_DisplayGroup
inherited

Set options from config object

Inherited from: \Zend_Form_DisplayGroup::setConfig()
Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicsetDecorators(array $decorators) : \Zend_Form_DisplayGroup
inherited

Overwrite all decorators

Inherited from: \Zend_Form_DisplayGroup::setDecorators()
Parameters
NameTypeDescription
$decoratorsarray
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicsetDescription(string $value) : \Zend_Form_DisplayGroup
inherited

Set description

Inherited from: \Zend_Form_DisplayGroup::setDescription()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicsetDisableLoadDefaultDecorators(bool $flag) : \Zend_Form_Element
inherited

Set flag to disable loading default decorators

Inherited from: \Zend_Form_DisplayGroup::setDisableLoadDefaultDecorators()
Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetDisableTranslator(bool $flag) : \Zend_Form_DisplayGroup
inherited

Indicate whether or not translation should be disabled

Inherited from: \Zend_Form_DisplayGroup::setDisableTranslator()
Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicsetElements(array $elements) : \Zend_Form_DisplayGroup
inherited

Set multiple elements at once (overwrites)

Inherited from: \Zend_Form_DisplayGroup::setElements()
Parameters
NameTypeDescription
$elementsarray
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicsetForm(\Zend_Form $form) : \Zend_Form_DisplayGroup
inherited

Set form object to which the display group is attached

Inherited from: \Zend_Form_DisplayGroup::setForm()
Parameters
NameTypeDescription
$form\Zend_Form
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicsetLegend(string $legend) : \Zend_Form_DisplayGroup
inherited

Set group legend

Inherited from: \Zend_Form_DisplayGroup::setLegend()
Parameters
NameTypeDescription
$legendstring
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicsetName(string $name) : \Zend_Form_DisplayGroup
inherited

Set group name

Inherited from: \Zend_Form_DisplayGroup::setName()
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicsetOptions(array $options) : \Zend_Form_DisplayGroup
inherited

Set options

Inherited from: \Zend_Form_DisplayGroup::setOptions()
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicsetOrder(int $order) : \Zend_Form_Element
inherited

Set group order

Inherited from: \Zend_Form_DisplayGroup::setOrder()
Parameters
NameTypeDescription
$orderint
Returns
TypeDescription
\Zend_Form_Element
methodpublicsetPluginLoader(\Zend_Loader_PluginLoader $loader) : \Zend_Form_DisplayGroup
inherited

Set plugin loader

Inherited from: \Zend_Form_DisplayGroup::setPluginLoader()
Parameters
NameTypeDescription
$loader\Zend_Loader_PluginLoader
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicsetTranslator(\Zend_Translate | \Zend_Translate_Adapter | null $translator = null) : \Zend_Form_DisplayGroup
inherited

Set translator object

Inherited from: \Zend_Form_DisplayGroup::setTranslator()
Parameters
NameTypeDescription
$translator\Zend_Translate | \Zend_Translate_Adapter | null
Returns
TypeDescription
\Zend_Form_DisplayGroup
methodpublicsetView(\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
NameTypeDescription
$view\Zend_View_Interface
Returns
TypeDescription
\Zend_Dojo_Form_Element_Dijit
methodpublictranslatorIsDisabled() : bool
inherited

Is translation disabled?

Inherited from: \Zend_Form_DisplayGroup::translatorIsDisabled()
Returns
TypeDescription
bool
methodpublicvalid() : bool
inherited

Determine if current element/subform/display group is valid

Inherited from: \Zend_Form_DisplayGroup::valid()
Returns
TypeDescription
bool
Documentation was generated by phpDocumentor 2.0.0a12.