API Documentation

Dojo/Form/DisplayGroup.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Dojo  
subpackage
Form  

\Zend_Dojo_Form_DisplayGroup

Dijit-enabled DisplayGroup

Extends from
\Zend_Form_DisplayGroup
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Dojo  
subpackage
Form  
uses
\Zend_Form_DisplayGroup  
version
$Id: DisplayGroup.php 23775 2011-03-01 17:25:24Z ralph $  

Methods

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

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
methodpublic__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
methodpublic__toString( ) : string

String representation of group

Inherited from: \Zend_Form_DisplayGroup::__toString()
Returns
Type Description
string
methodprotected_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()
Parameters
Name Type Description
$name string
$options null|array
Returns
Type Description
\Zend_Form_Decorator_Interface
methodprotected_loadDecorator( array $decorator, mixed $name ) : \Zend_Form_Decorator_Interface

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
methodprotected_sort( ) : void

Sort items according to their order

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

Add multiple form attributes at once

Inherited from: \Zend_Form_DisplayGroup::addAttribs()
Parameters
Name Type Description
$attribs array
Returns
Type Description
\Zend_Form_DisplayGroup
methodpublicaddDecorator( 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()
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
methodpublicaddDecorators( array $decorators ) : \Zend_Form_DisplayGroup

Add many decorators at once

Inherited from: \Zend_Form_DisplayGroup::addDecorators()
Parameters
Name Type Description
$decorators array
Returns
Type Description
\Zend_Form_DisplayGroup
methodpublicaddElement( \Zend_Form_Element $element ) : \Zend_Form_DisplayGroup

Add element to stack

Inherited from: \Zend_Form_DisplayGroup::addElement()
Parameters
Name Type Description
$element \Zend_Form_Element
Returns
Type Description
\Zend_Form_DisplayGroup
methodpublicaddElements( array $elements ) : \Zend_Form_DisplayGroup

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
methodpublicaddPrefixPath( string $prefix, string $path ) : \Zend_Form_DisplayGroup

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
methodpublicaddPrefixPaths( array $spec ) : \Zend_Form_DisplayGroup

Add several prefix paths at once

Inherited from: \Zend_Form_DisplayGroup::addPrefixPaths()
Parameters
Name Type Description
$spec array
Returns
Type Description
\Zend_Form_DisplayGroup
methodpublicclearAttribs( ) : \Zend_Form

Clear all form attributes

Inherited from: \Zend_Form_DisplayGroup::clearAttribs()
Returns
Type Description
\Zend_Form
methodpublicclearDecorators( ) : \Zend_Form_DisplayGroup

Clear all decorators

Inherited from: \Zend_Form_DisplayGroup::clearDecorators()
Returns
Type Description
\Zend_Form_DisplayGroup
methodpublicclearElements( ) : \Zend_Form_DisplayGroup

Remove all elements

Inherited from: \Zend_Form_DisplayGroup::clearElements()
Returns
Type Description
\Zend_Form_DisplayGroup
methodpubliccount( ) : int

Count of elements/subforms that are iterable

Inherited from: \Zend_Form_DisplayGroup::count()
Returns
Type Description
int
methodpubliccurrent( ) : \Zend_Form_Element

Current element

Inherited from: \Zend_Form_DisplayGroup::current()
Returns
Type Description
\Zend_Form_Element
methodpublicfilterName( string $value ) : string

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
methodpublicgetAttrib( string $key ) : mixed

Retrieve a single form attribute

Inherited from: \Zend_Form_DisplayGroup::getAttrib()
Parameters
Name Type Description
$key string
Returns
Type Description
mixed
methodpublicgetAttribs( ) : array

Retrieve all form attributes/metadata

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

Retrieve a registered decorator

Inherited from: \Zend_Form_DisplayGroup::getDecorator()
Parameters
Name Type Description
$name string
Returns
Type Description
false\Zend_Form_Decorator_Abstract
methodpublicgetDecorators( ) : array

Retrieve all decorators

Inherited from: \Zend_Form_DisplayGroup::getDecorators()
Returns
Type Description
array
methodpublicgetDescription( ) : string

Get description

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

Retrieve element

Inherited from: \Zend_Form_DisplayGroup::getElement()
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Form_Elementnull
methodpublicgetElements( ) : array

Retrieve elements

Inherited from: \Zend_Form_DisplayGroup::getElements()
Returns
Type Description
array
methodpublicgetForm( ) : \Zend_Form|null

Get form object to which the group is attached

Inherited from: \Zend_Form_DisplayGroup::getForm()
Returns
Type Description
\Zend_Formnull
methodpublicgetFullyQualifiedName( ) : string

Get fully qualified name

Inherited from: \Zend_Form_DisplayGroup::getFullyQualifiedName()

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

Returns
Type Description
string
methodpublicgetId( ) : string

Get element id

Inherited from: \Zend_Form_DisplayGroup::getId()
Returns
Type Description
string
methodpublicgetLegend( ) : string

Retrieve group legend

Inherited from: \Zend_Form_DisplayGroup::getLegend()
Returns
Type Description
string
methodpublicgetName( ) : string

Retrieve group name

Inherited from: \Zend_Form_DisplayGroup::getName()
Returns
Type Description
string
methodpublicgetOrder( ) : int

Retrieve group order

Inherited from: \Zend_Form_DisplayGroup::getOrder()
Returns
Type Description
int
methodpublicgetPluginLoader( ) : \Zend_Loader_PluginLoader

Retrieve plugin loader

Inherited from: \Zend_Form_DisplayGroup::getPluginLoader()
Returns
Type Description
\Zend_Loader_PluginLoader
methodpublicgetTranslator( ) : \Zend_Translate_Adapter|null

Retrieve translator object

Inherited from: \Zend_Form_DisplayGroup::getTranslator()
Returns
Type Description
\Zend_Translate_Adapternull
methodpublicgetView( ) : \Zend_View_Interface

Retrieve view

Inherited from: \Zend_Form_DisplayGroup::getView()
Returns
Type Description
\Zend_View_Interface
methodpublicinit( ) : void

Initialize object; used by extending classes

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

Current element

Inherited from: \Zend_Form_DisplayGroup::key()
Returns
Type Description
string
methodpublicloadDefaultDecorators( ) : \Zend_Form_DisplayGroup

Load default decorators

Inherited from: \Zend_Form_DisplayGroup::loadDefaultDecorators()
Returns
Type Description
\Zend_Form_DisplayGroup
methodpublicloadDefaultDecoratorsIsDisabled( ) : bool

Should we load the default decorators?

Inherited from: \Zend_Form_DisplayGroup::loadDefaultDecoratorsIsDisabled()
Returns
Type Description
bool
methodpublicnext( ) : void

Move pointer to next element

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

Remove attribute

Inherited from: \Zend_Form_DisplayGroup::removeAttrib()
Parameters
Name Type Description
$key string
Returns
Type Description
bool
methodpublicremoveDecorator( string $name ) : bool

Remove a single decorator

Inherited from: \Zend_Form_DisplayGroup::removeDecorator()
Parameters
Name Type Description
$name string
Returns
Type Description
bool
methodpublicremoveElement( string $name ) : boolean

Remove a single element

Inherited from: \Zend_Form_DisplayGroup::removeElement()
Parameters
Name Type Description
$name string
Returns
Type Description
boolean
methodpublicrender(  $view = null ) : string

Render display group

Inherited from: \Zend_Form_DisplayGroup::render()
Parameters
Name Type Description
$view
Returns
Type Description
string
methodpublicrewind( ) : void

Move pointer to beginning of element loop

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

Set group attribute

Inherited from: \Zend_Form_DisplayGroup::setAttrib()
Parameters
Name Type Description
$key string
$value mixed
Returns
Type Description
\Zend_Form_DisplayGroup
methodpublicsetAttribs( array $attribs ) : \Zend_Form_DisplayGroup

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
methodpublicsetConfig( \Zend_Config $config ) : \Zend_Form_DisplayGroup

Set options from config object

Inherited from: \Zend_Form_DisplayGroup::setConfig()
Parameters
Name Type Description
$config \Zend_Config
Returns
Type Description
\Zend_Form_DisplayGroup
methodpublicsetDecorators( array $decorators ) : \Zend_Form_DisplayGroup

Overwrite all decorators

Inherited from: \Zend_Form_DisplayGroup::setDecorators()
Parameters
Name Type Description
$decorators array
Returns
Type Description
\Zend_Form_DisplayGroup
methodpublicsetDescription( string $value ) : \Zend_Form_DisplayGroup

Set description

Inherited from: \Zend_Form_DisplayGroup::setDescription()
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Form_DisplayGroup
methodpublicsetDisableLoadDefaultDecorators( bool $flag ) : \Zend_Form_Element

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
methodpublicsetDisableTranslator( bool $flag ) : \Zend_Form_DisplayGroup

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
methodpublicsetElements( array $elements ) : \Zend_Form_DisplayGroup

Set multiple elements at once (overwrites)

Inherited from: \Zend_Form_DisplayGroup::setElements()
Parameters
Name Type Description
$elements array
Returns
Type Description
\Zend_Form_DisplayGroup
methodpublicsetForm( \Zend_Form $form ) : \Zend_Form_DisplayGroup

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
methodpublicsetLegend( string $legend ) : \Zend_Form_DisplayGroup

Set group legend

Inherited from: \Zend_Form_DisplayGroup::setLegend()
Parameters
Name Type Description
$legend string
Returns
Type Description
\Zend_Form_DisplayGroup
methodpublicsetName( string $name ) : \Zend_Form_DisplayGroup

Set group name

Inherited from: \Zend_Form_DisplayGroup::setName()
Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Form_DisplayGroup
methodpublicsetOptions( array $options ) : \Zend_Form_DisplayGroup

Set options

Inherited from: \Zend_Form_DisplayGroup::setOptions()
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Form_DisplayGroup
methodpublicsetOrder( int $order ) : \Zend_Form_Element

Set group order

Inherited from: \Zend_Form_DisplayGroup::setOrder()
Parameters
Name Type Description
$order int
Returns
Type Description
\Zend_Form_Element
methodpublicsetPluginLoader( \Zend_Loader_PluginLoader $loader ) : \Zend_Form_DisplayGroup

Set plugin loader

Inherited from: \Zend_Form_DisplayGroup::setPluginLoader()
Parameters
Name Type Description
$loader \Zend_Loader_PluginLoader
Returns
Type Description
\Zend_Form_DisplayGroup
methodpublicsetTranslator( \Zend_Translate|\Zend_Translate_Adapter|null $translator = null ) : \Zend_Form_DisplayGroup

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
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
Name Type Description
$view \Zend_View_Interface
Returns
Type Description
\Zend_Dojo_Form_Element_Dijit
methodpublictranslatorIsDisabled( ) : bool

Is translation disabled?

Inherited from: \Zend_Form_DisplayGroup::translatorIsDisabled()
Returns
Type Description
bool
methodpublicvalid( ) : bool

Determine if current element/subform/display group is valid

Inherited from: \Zend_Form_DisplayGroup::valid()
Returns
Type Description
bool
Documentation was generated by DocBlox 0.13.3.