Form/DisplayGroup.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Form
Classes: Zend_Form_DisplayGroup

Description

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

Implements
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Form
version: $Id: DisplayGroup.php 22465 2010-06-19 17:41:03Z alab $
Properties: $_attribs; $_decorators; $_description; $_disableLoadDefaultDecorators; $_elementOrder; $_elements; $_groupUpdated; $_loader; $_name; $_order; $_translator; $_translatorDisabled; $_view
Methods: __construct; init; setOptions; setConfig; setAttrib; addAttribs; setAttribs; getAttrib; getAttribs; removeAttrib; clearAttribs; filterName; setName; getName; getFullyQualifiedName; getId; setLegend; getLegend; setDescription; getDescription; setOrder; getOrder; addElement; addElements; setElements; getElement; getElements; removeElement; clearElements; setPluginLoader; getPluginLoader; addPrefixPath; addPrefixPaths; setDisableLoadDefaultDecorators; loadDefaultDecoratorsIsDisabled; loadDefaultDecorators; _getDecorator; addDecorator; addDecorators; setDecorators; getDecorator; getDecorators; removeDecorator; clearDecorators; setView; getView; render; __toString; setTranslator; getTranslator; setDisableTranslator; translatorIsDisabled; __call; current; key; next; rewind; valid; count; _sort; _loadDecorator

Description

Zend_Form_DisplayGroup

Properties

$_attribs
jump to class

array $_attribs = 'array'

Group attributes

Details

$_attribs: array
visibility: protected
default: array
final: false
static: false

$_decorators
jump to class

array $_decorators = 'array'

Display group decorators

Details

$_decorators: array
visibility: protected
default: array
final: false
static: false

$_description
jump to class

string $_description = ''

Description

Details

$_description: string
visibility: protected
default
final: false
static: false

$_disableLoadDefaultDecorators
jump to class

bool $_disableLoadDefaultDecorators = 'false'

Should we disable loading the default decorators?

Details

$_disableLoadDefaultDecorators: bool
visibility: protected
default: false
final: false
static: false

$_elementOrder
jump to class

array $_elementOrder = 'array'

Element order

Details

$_elementOrder: array
visibility: protected
default: array
final: false
static: false

$_elements
jump to class

array $_elements = 'array'

Elements

Details

$_elements: array
visibility: protected
default: array
final: false
static: false

$_groupUpdated
jump to class

bool $_groupUpdated = 'false'

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

Details

$_groupUpdated: bool
visibility: protected
default: false
final: false
static: false

$_loader
jump to class

Zend_Loader_PluginLoader $_loader = ''

Plugin loader for decorators

Details

$_loader: Zend_Loader_PluginLoader
visibility: protected
default
final: false
static: false

$_name
jump to class

string $_name = ''

Group name

Details

$_name: string
visibility: protected
default
final: false
static: false

$_order
jump to class

int $_order = ''

Group order

Details

$_order: int
visibility: protected
default
final: false
static: false

$_translator
jump to class

Zend_Translate $_translator = ''

Details

$_translator: Zend_Translate
visibility: protected
default
final: false
static: false

$_translatorDisabled
jump to class

bool $_translatorDisabled = 'false'

Is translation disabled?

Details

$_translatorDisabled: bool
visibility: protected
default: false
final: false
static: false

$_view
jump to class

Zend_View_Interface $_view = ''

Details

$_view: Zend_View_Interface
visibility: protected
default
final: false
static: false

Methods

__call
jump to class

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

Overloading: allow rendering specific decorators

Call renderDecoratorName() to render a specific decorator.

Arguments

$method: string
$args: array

Output

string

Details

visibility: public
final: false
static: false
throws: for invalid decorator or invalid method call

__construct
jump to class

__construct(
          string $name, Zend_Loader_PluginLoader $loader, array|Zend_Config $options
              =
              null
          )
        
        :
        void

Constructor

Arguments

$name: string
$loader: Zend_Loader_PluginLoader
$options: arrayZend_Config

Details

visibility: public
final: false
static: false

__toString
jump to class

__toString(
          
          )
        
        :
        string

String representation of group

Output

string

Details

visibility: public
final: false
static: false

_getDecorator
jump to class

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

Instantiate a decorator based on class name or class name fragment

Arguments

$name: string
$options: nullarray

Output

Zend_Form_Decorator_Interface

Details

visibility: protected
final: false
static: false

_loadDecorator
jump to class

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

Lazy-load a decorator

Arguments

$decorator: array
Decorator type and options
$name: mixed
Decorator name or alias

Output

Zend_Form_Decorator_Interface

Details

visibility: protected
final: false
static: false

_sort
jump to class

Sort items according to their order

Details

visibility: protected
final: false
static: false

addAttribs
jump to class

addAttribs(
          array $attribs
          )
        
        :
        Zend_Form_DisplayGroup

Add multiple form attributes at once

Arguments

$attribs: array

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

addDecorator
jump to class

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

Add a decorator for rendering the group

Arguments

$decorator: stringZend_Form_Decorator_Interface
$options: arrayZend_Config
Options with which to initialize decorator

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

addDecorators
jump to class

addDecorators(
          array $decorators
          )
        
        :
        Zend_Form_DisplayGroup

Add many decorators at once

Arguments

$decorators: array

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

addElement
jump to class

addElement(
          Zend_Form_Element $element
          )
        
        :
        Zend_Form_DisplayGroup

Add element to stack

Arguments

$element: Zend_Form_Element

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

addElements
jump to class

addElements(
          array $elements
          )
        
        :
        Zend_Form_DisplayGroup

Add multiple elements at once

Arguments

$elements: array

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false
throws: if any element is not a Zend_Form_Element

addPrefixPath
jump to class

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

Add a prefix path for the plugin loader

Arguments

$prefix: string
$path: string

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

addPrefixPaths
jump to class

addPrefixPaths(
          array $spec
          )
        
        :
        Zend_Form_DisplayGroup

Add several prefix paths at once

Arguments

$spec: array

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

clearAttribs
jump to class

clearAttribs(
          
          )
        
        :
        Zend_Form

Clear all form attributes

Output

Zend_Form

Details

visibility: public
final: false
static: false

clearDecorators
jump to class

clearDecorators(
          
          )
        
        :
        Zend_Form_DisplayGroup

Clear all decorators

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

clearElements
jump to class

clearElements(
          
          )
        
        :
        Zend_Form_DisplayGroup

Remove all elements

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

count
jump to class

Count of elements/subforms that are iterable

Output

int

Details

visibility: public
final: false
static: false

current
jump to class

current(
          
          )
        
        :
        Zend_Form_Element

Current element

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

filterName
jump to class

filterName(
          string $value
          )
        
        :
        string

Filter a name to only allow valid variable characters

Arguments

$value: string

Output

string

Details

visibility: public
final: false
static: false

getAttrib
jump to class

getAttrib(
          string $key
          )
        
        :
        mixed

Retrieve a single form attribute

Arguments

$key: string

Output

mixed

Details

visibility: public
final: false
static: false

getAttribs
jump to class

getAttribs(
          
          )
        
        :
        array

Retrieve all form attributes/metadata

Output

array

Details

visibility: public
final: false
static: false

getDecorator
jump to class

getDecorator(
          string $name
          )
        
        :
        false|Zend_Form_Decorator_Abstract

Retrieve a registered decorator

Arguments

$name: string

Output

false|Zend_Form_Decorator_Abstract

Details

visibility: public
final: false
static: false

getDecorators
jump to class

getDecorators(
          
          )
        
        :
        array

Retrieve all decorators

Output

array

Details

visibility: public
final: false
static: false

getDescription
jump to class

getDescription(
          
          )
        
        :
        string

Get description

Output

string

Details

visibility: public
final: false
static: false

getElement
jump to class

getElement(
          string $name
          )
        
        :
        Zend_Form_Element|null

Retrieve element

Arguments

$name: string

Output

Zend_Form_Element|null

Details

visibility: public
final: false
static: false

getElements
jump to class

getElements(
          
          )
        
        :
        array

Retrieve elements

Output

array

Details

visibility: public
final: false
static: false

getFullyQualifiedName
jump to class

getFullyQualifiedName(
          
          )
        
        :
        string

Get fully qualified name

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

Output

string

Details

visibility: public
final: false
static: false

getId
jump to class

getId(
          
          )
        
        :
        string

Get element id

Output

string

Details

visibility: public
final: false
static: false

getLegend
jump to class

getLegend(
          
          )
        
        :
        string

Retrieve group legend

Output

string

Details

visibility: public
final: false
static: false

getName
jump to class

getName(
          
          )
        
        :
        string

Retrieve group name

Output

string

Details

visibility: public
final: false
static: false

getOrder
jump to class

getOrder(
          
          )
        
        :
        int

Retrieve group order

Output

int

Details

visibility: public
final: false
static: false

getPluginLoader
jump to class

getPluginLoader(
          
          )
        
        :
        Zend_Loader_PluginLoader

Retrieve plugin loader

Output

Zend_Loader_PluginLoader

Details

visibility: public
final: false
static: false

getTranslator
jump to class

getTranslator(
          
          )
        
        :
        Zend_Translate_Adapter|null

Retrieve translator object

Output

Zend_Translate_Adapter|null

Details

visibility: public
final: false
static: false

getView
jump to class

getView(
          
          )
        
        :
        Zend_View_Interface

Retrieve view

Output

Zend_View_Interface

Details

visibility: public
final: false
static: false

init
jump to class

Initialize object; used by extending classes

Details

visibility: public
final: false
static: false

key
jump to class

Current element

Output

string

Details

visibility: public
final: false
static: false

loadDefaultDecorators
jump to class

loadDefaultDecorators(
          
          )
        
        :
        void

Load default decorators

Details

visibility: public
final: false
static: false

loadDefaultDecoratorsIsDisabled
jump to class

loadDefaultDecoratorsIsDisabled(
          
          )
        
        :
        bool

Should we load the default decorators?

Output

bool

Details

visibility: public
final: false
static: false

next
jump to class

Move pointer to next element

Details

visibility: public
final: false
static: false

removeAttrib
jump to class

removeAttrib(
          string $key
          )
        
        :
        bool

Remove attribute

Arguments

$key: string

Output

bool

Details

visibility: public
final: false
static: false

removeDecorator
jump to class

removeDecorator(
          string $name
          )
        
        :
        bool

Remove a single decorator

Arguments

$name: string

Output

bool

Details

visibility: public
final: false
static: false

removeElement
jump to class

removeElement(
          string $name
          )
        
        :
        boolean

Remove a single element

Arguments

$name: string

Output

boolean

Details

visibility: public
final: false
static: false

render
jump to class

render(
           $view
              =
              null
          )
        
        :
        string

Render display group

Arguments

$view

Output

string

Details

visibility: public
final: false
static: false

rewind
jump to class

rewind(
          
          )
        
        :
        void

Move pointer to beginning of element loop

Details

visibility: public
final: false
static: false

setAttrib
jump to class

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

Set group attribute

Arguments

$key: string
$value: mixed

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

setAttribs
jump to class

setAttribs(
          array $attribs
          )
        
        :
        Zend_Form_DisplayGroup

Set multiple form attributes at once

Overwrites any previously set attributes.

Arguments

$attribs: array

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

setConfig
jump to class

setConfig(
          Zend_Config $config
          )
        
        :
        Zend_Form_DisplayGroup

Set options from config object

Arguments

$config: Zend_Config

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

setDecorators
jump to class

setDecorators(
          array $decorators
          )
        
        :
        Zend_Form_DisplayGroup

Overwrite all decorators

Arguments

$decorators: array

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

setDescription
jump to class

setDescription(
          string $value
          )
        
        :
        Zend_Form_DisplayGroup

Set description

Arguments

$value: string

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

setDisableLoadDefaultDecorators
jump to class

setDisableLoadDefaultDecorators(
          bool $flag
          )
        
        :
        Zend_Form_Element

Set flag to disable loading default decorators

Arguments

$flag: bool

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setDisableTranslator
jump to class

setDisableTranslator(
          bool $flag
          )
        
        :
        Zend_Form_DisplayGroup

Indicate whether or not translation should be disabled

Arguments

$flag: bool

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

setElements
jump to class

setElements(
          array $elements
          )
        
        :
        Zend_Form_DisplayGroup

Set multiple elements at once (overwrites)

Arguments

$elements: array

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

setLegend
jump to class

setLegend(
          string $legend
          )
        
        :
        Zend_Form_DisplayGroup

Set group legend

Arguments

$legend: string

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

setName
jump to class

setName(
          string $name
          )
        
        :
        Zend_Form_DisplayGroup

Set group name

Arguments

$name: string

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

setOptions
jump to class

setOptions(
          array $options
          )
        
        :
        Zend_Form_DisplayGroup

Set options

Arguments

$options: array

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

setOrder
jump to class

setOrder(
          int $order
          )
        
        :
        Zend_Form_Element

Set group order

Arguments

$order: int

Output

Zend_Form_Element

Details

visibility: public
final: false
static: false

setPluginLoader
jump to class

setPluginLoader(
          Zend_Loader_PluginLoader $loader
          )
        
        :
        Zend_Form_DisplayGroup

Set plugin loader

Arguments

$loader: Zend_Loader_PluginLoader

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

setTranslator
jump to class

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

Set translator object

Arguments

$translator: Zend_TranslateZend_Translate_Adapternull

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

setView
jump to class

setView(
          Zend_View_Interface $view
              =
              null
          )
        
        :
        Zend_Form_DisplayGroup

Set view

Arguments

$view: Zend_View_Interface

Output

Zend_Form_DisplayGroup

Details

visibility: public
final: false
static: false

translatorIsDisabled
jump to class

translatorIsDisabled(
          
          )
        
        :
        bool

Is translation disabled?

Output

bool

Details

visibility: public
final: false
static: false

valid
jump to class

Determine if current element/subform/display group is valid

Output

bool

Details

visibility: public
final: false
static: false

API Documentation

Form/DisplayGroup.php

Description

Zend_Form_DisplayGroupjump to top

Description

Properties

$_attribsjump to class

Details

$_decoratorsjump to class

Details

$_descriptionjump to class

Details

$_disableLoadDefaultDecoratorsjump to class

Details

$_elementOrderjump to class

Details

$_elementsjump to class

Details

$_groupUpdatedjump to class

Details

$_loaderjump to class

Details

$_namejump to class

Details

$_orderjump to class

Details

$_translatorjump to class

Details

$_translatorDisabledjump to class

Details

$_viewjump to class

Details

Methods

__calljump to class

Arguments

Output

Details

__constructjump to class

Arguments

Details

__toStringjump to class

Output

Details

_getDecoratorjump to class

Arguments

Output

Details

_loadDecoratorjump to class

Arguments

Output

Details

_sortjump to class

Details

addAttribsjump to class

Arguments

Output

Details

addDecoratorjump to class

Arguments

Output

Details

addDecoratorsjump to class

Arguments

Output

Details

addElementjump to class

Arguments

Output

Details

addElementsjump to class

Arguments

Output

Details

addPrefixPathjump to class

Arguments

Output

Details

addPrefixPathsjump to class

Arguments

Output

Zend_Form_DisplayGroup
jump to top

$_attribs
jump to class

$_decorators
jump to class

$_description
jump to class

$_disableLoadDefaultDecorators
jump to class

$_elementOrder
jump to class

$_elements
jump to class

$_groupUpdated
jump to class

$_loader
jump to class

$_name
jump to class

$_order
jump to class

$_translator
jump to class

$_translatorDisabled
jump to class

$_view
jump to class

__call
jump to class

__construct
jump to class

__toString
jump to class

_getDecorator
jump to class

_loadDecorator
jump to class

_sort
jump to class

addAttribs
jump to class

addDecorator
jump to class

addDecorators
jump to class

addElement
jump to class

addElements
jump to class

addPrefixPath
jump to class

addPrefixPaths
jump to class

clearAttribs
jump to class

clearDecorators
jump to class

clearElements
jump to class

count
jump to class

current
jump to class

filterName
jump to class

getAttrib
jump to class

getAttribs
jump to class

getDecorator
jump to class

getDecorators
jump to class

getDescription
jump to class

getElement
jump to class

getElements
jump to class

getFullyQualifiedName
jump to class

getId
jump to class

getLegend
jump to class

getName
jump to class

getOrder
jump to class

getPluginLoader
jump to class

getTranslator
jump to class

getView
jump to class

init
jump to class