Class Zend_Form_DisplayGroup

Description

Implements interfaces:

  • Iterator (internal interface)
  • Countable (internal interface)

Zend_Form_DisplayGroup

  • version: $Id: DisplayGroup.php 11316 2008-09-09 19:17:43Z matthew $
  • copyright: Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
  • usedby: Zend_Dojo_Form_DisplayGroup
  • license: New BSD License

Located in /Form/DisplayGroup.php (line 30)


	
			
Direct descendents
Class Description
 class Zend_Dojo_Form_DisplayGroup Dijit-enabled DisplayGroup
Variable Summary
Method Summary
 void __construct (string $name,  $loader, [array|Zend_Config $options = null])
 Zend_Form_DisplayGroup addDecorator (string|Zend_Form_Decorator_Interface $decorator, [array|Zend_Config $options = null])
 Zend_Form_DisplayGroup addPrefixPath (string $prefix, string $path)
 int count ()
 string filterName (string $value)
 mixed getAttrib (string $key)
 array getAttribs ()
 array getDecorators ()
 string getDescription ()
 Zend_Form_Element|null getElement (string $name)
 array getElements ()
 string getId ()
 string getLegend ()
 string getName ()
 int getOrder ()
 void init ()
 string key ()
 void next ()
 bool removeAttrib (string $key)
 bool removeDecorator (string $name)
 boolean removeElement (string $name)
 string render ([ $view = null])
 void rewind ()
 Zend_Form_DisplayGroup setAttrib (string $key, mixed $value)
 Zend_Form_DisplayGroup setLegend (string $legend)
 Zend_Form_Element setOrder (int $order)
 Zend_Form_DisplayGroup setView ([ $view = null])
 bool valid ()
 Zend_Form_Decorator_Interface _getDecorator (string $name, [null|array $options = null])
 Zend_Form_Decorator_Interface _loadDecorator ( $decorator, mixed $name)
 void _sort ()
 string __call (string $method, array $args)
 string __toString ()
Variables
array $_attribs = array() (line 36)

Group attributes

  • access: protected
array $_decorators = array() (line 42)

Display group decorators

  • access: protected
string $_description (line 48)

Description

  • access: protected
bool $_disableLoadDefaultDecorators = false (line 54)

Should we disable loading the default decorators?

  • access: protected
array $_elementOrder = array() (line 60)

Element order

  • access: protected
array $_elements = array() (line 66)

Elements

  • access: protected
bool $_groupUpdated = false (line 72)

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

  • access: protected
Zend_Loader_PluginLoader $_loader (line 78)

Plugin loader for decorators

  • access: protected
string $_name (line 84)

Group name

  • access: protected
int $_order (line 90)

Group order

  • access: protected
Zend_Translate $_translator (line 95)
  • access: protected
bool $_translatorDisabled = false (line 101)

Is translation disabled?

  • access: protected
Zend_View_Interface $_view (line 106)
  • access: protected
Methods
Constructor __construct (line 116)

Constructor

  • access: public
void __construct (string $name,  $loader, [array|Zend_Config $options = null])

Redefined in descendants as:
addAttribs (line 203)

Add multiple form attributes at once

  • access: public
Zend_Form_DisplayGroup addAttribs ( $attribs)
  • array $attribs
addDecorator (line 662)

Add a decorator for rendering the group

  • access: public
Zend_Form_DisplayGroup addDecorator (string|Zend_Form_Decorator_Interface $decorator, [array|Zend_Config $options = null])
addDecorators (line 704)

Add many decorators at once

  • access: public
Zend_Form_DisplayGroup addDecorators ( $decorators)
  • array $decorators
addElement (line 431)

Add element to stack

  • access: public
Zend_Form_DisplayGroup addElement (Zend_Form_Element $element)
addElements (line 445)

Add multiple elements at once

  • throws: Zend_Form_Exception if any element is not a Zend_Form_Element
  • access: public
Zend_Form_DisplayGroup addElements ( $elements)
  • array $elements
addPrefixPath (line 555)

Add a prefix path for the plugin loader

  • access: public
Zend_Form_DisplayGroup addPrefixPath (string $prefix, string $path)
  • string $prefix
  • string $path
addPrefixPaths (line 567)

Add several prefix paths at once

  • access: public
Zend_Form_DisplayGroup addPrefixPaths ( $spec)
  • array $spec
clearAttribs (line 272)

Clear all form attributes

  • access: public
Zend_Form clearAttribs ()
clearDecorators (line 828)

Clear all decorators

  • access: public
Zend_Form_DisplayGroup clearDecorators ()
clearElements (line 517)

Remove all elements

  • access: public
Zend_Form_DisplayGroup clearElements ()
count (line 1051)

Count of elements/subforms that are iterable

  • access: public
int count ()

Implementation of:
Countable::count
current (line 994)

Current element

  • access: public
Zend_Form_Element current ()

Implementation of:
Iterator::current
filterName (line 284)

Filter a name to only allow valid variable characters

  • access: public
string filterName (string $value)
  • string $value
getAttrib (line 231)

Retrieve a single form attribute

  • access: public
mixed getAttrib (string $key)
  • string $key
getAttribs (line 246)

Retrieve all form attributes/metadata

  • access: public
array getAttribs ()
getDecorator (line 760)

Retrieve a registered decorator

  • access: public
false|Zend_Form_Decorator_Abstract getDecorator (string $name)
  • string $name
getDecorators (line 791)

Retrieve all decorators

  • access: public
array getDecorators ()
getDescription (line 396)

Get description

  • access: public
string getDescription ()
getElement (line 475)

Retrieve element

  • access: public
Zend_Form_Element|null getElement (string $name)
  • string $name
getElements (line 489)

Retrieve elements

  • access: public
array getElements ()
getFullyQualifiedName (line 324)

Get fully qualified name

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

  • access: public
string getFullyQualifiedName ()
getId (line 334)

Get element id

  • access: public
string getId ()
getLegend (line 374)

Retrieve group legend

  • access: public
string getLegend ()
getName (line 312)

Retrieve group name

  • access: public
string getName ()
getOrder (line 418)

Retrieve group order

  • access: public
int getOrder ()
getPluginLoader (line 543)

Retrieve plugin loader

  • access: public
Zend_Loader_PluginLoader getPluginLoader ()
getTranslator (line 920)

Retrieve translator object

  • access: public
Zend_Translate_Adapter|null getTranslator ()
getView (line 851)

Retrieve view

  • access: public
Zend_View_Interface getView ()
init (line 139)

Initialize object; used by extending classes

  • access: public
void init ()
key (line 1007)

Current element

  • access: public
string key ()

Implementation of:
Iterator::key
loadDefaultDecorators (line 620)

Load default decorators

  • access: public
void loadDefaultDecorators ()
loadDefaultDecoratorsIsDisabled (line 610)

Should we load the default decorators?

  • access: public
bool loadDefaultDecoratorsIsDisabled ()
next (line 1018)

Move pointer to next element

  • access: public
void next ()

Implementation of:
Iterator::next
removeAttrib (line 257)

Remove attribute

  • access: public
bool removeAttrib (string $key)
  • string $key
removeDecorator (line 807)

Remove a single decorator

  • access: public
bool removeDecorator (string $name)
  • string $name
removeElement (line 500)

Remove a single element

  • access: public
boolean removeElement (string $name)
  • string $name
render (line 867)

Render display group

  • access: public
string render ([ $view = null])
rewind (line 1029)

Move pointer to beginning of element loop

  • access: public
void rewind ()

Implementation of:
Iterator::rewind
setAttrib (line 190)

Set group attribute

  • access: public
Zend_Form_DisplayGroup setAttrib (string $key, mixed $value)
  • string $key
  • mixed $value
setAttribs (line 219)

Set multiple form attributes at once

Overwrites any previously set attributes.

  • access: public
Zend_Form_DisplayGroup setAttribs ( $attribs)
  • array $attribs
setConfig (line 178)

Set options from config object

  • access: public
Zend_Form_DisplayGroup setConfig ( $config)
setDecorators (line 748)

Overwrite all decorators

  • access: public
Zend_Form_DisplayGroup setDecorators ( $decorators)
  • array $decorators
setDescription (line 385)

Set description

  • access: public
Zend_Form_DisplayGroup setDescription (string $value)
  • string $value
setDisableLoadDefaultDecorators (line 599)

Set flag to disable loading default decorators

  • access: public
Zend_Form_Element setDisableLoadDefaultDecorators (bool $flag)
  • bool $flag
setDisableTranslator (line 940)

Indicate whether or not translation should be disabled

  • access: public
Zend_Form_DisplayGroup setDisableTranslator (bool $flag)
  • bool $flag
setElements (line 463)

Set multiple elements at once (overwrites)

  • access: public
Zend_Form_DisplayGroup setElements ( $elements)
  • array $elements
setLegend (line 364)

Set group legend

  • access: public
Zend_Form_DisplayGroup setLegend (string $legend)
  • string $legend
setName (line 295)

Set group name

  • access: public
Zend_Form_DisplayGroup setName (string $name)
  • string $name
setOptions (line 149)

Set options

  • access: public
Zend_Form_DisplayGroup setOptions ( $options)
  • array $options
setOrder (line 407)

Set group order

  • access: public
Zend_Form_Element setOrder (int $order)
  • int $order
setPluginLoader (line 532)

Set plugin loader

  • access: public
Zend_Form_DisplayGroup setPluginLoader ( $loader)
setTranslator (line 902)

Set translator object

  • access: public
Zend_Form_DisplayGroup setTranslator ([Zend_Translate|Zend_Translate_Adapter|null $translator = null])
setView (line 840)

Set view

  • access: public
Zend_Form_DisplayGroup setView ([ $view = null])

Redefined in descendants as:
translatorIsDisabled (line 951)

Is translation disabled?

  • access: public
bool translatorIsDisabled ()
valid (line 1040)

Determine if current element/subform/display group is valid

  • access: public
bool valid ()

Implementation of:
Iterator::valid
_getDecorator (line 642)

Instantiate a decorator based on class name or class name fragment

  • access: protected
Zend_Form_Decorator_Interface _getDecorator (string $name, [null|array $options = null])
  • string $name
  • null|array $options
_loadDecorator (line 1097)

Lazy-load a decorator

  • access: protected
Zend_Form_Decorator_Interface _loadDecorator ( $decorator, mixed $name)
  • array $decorator: Decorator type and options
  • mixed $name: Decorator name or alias
_sort (line 1061)

Sort items according to their order

  • access: protected
void _sort ()
__call (line 966)

Overloading: allow rendering specific decorators

Call renderDecoratorName() to render a specific decorator.

  • throws: Zend_Form_Exception for invalid decorator or invalid method call
  • access: public
string __call (string $method, array $args)
  • string $method
  • array $args
__toString (line 885)

String representation of group

  • access: public
string __toString ()

Documentation generated on Sun, 12 Oct 2008 23:39:35 +0400 by phpDocumentor 1.4.2