Form/DisplayGroup.php

Show:

inherited

Classes
- \Zend_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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Form

\Zend_Form_DisplayGroup
jump to top

Package: Zend_Form

Zend_Form_DisplayGroup

Implements
Children: \Zend_Dojo_Form_DisplayGroup
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Version: $Id$

Properties

array $_attribs = array()

Group attributes

Default valuearray()Details

Type: array

array $_decorators = array()

Display group decorators

Default valuearray()Details

Type: array

string $_description

Description

Details

Type: string

bool $_disableLoadDefaultDecorators = false

Should we disable loading the default decorators?

Default valuefalseDetails

Type: bool

array $_elementOrder = array()

Element order

Default valuearray()Details

Type: array

array $_elements = array()

Elements

Default valuearray()Details

Type: array

\Zend_Form $_form

Form object to which the display group is currently registered

Details

Type: \Zend_Form

bool $_groupUpdated = false

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

Default valuefalseDetails

Type: bool

\Zend_Loader_PluginLoader $_loader

Plugin loader for decorators

Details

Type: \Zend_Loader_PluginLoader

string $_name

Group name

Details

Type: string

int $_order

Group order

Details

Type: int

\Zend_Translate $_translator

Details

Type: \Zend_Translate

bool $_translatorDisabled = false

Is translation disabled?

Default valuefalseDetails

Type: bool

\Zend_View_Interface $_view

Details

Type: \Zend_View_Interface

Methods

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

Overloading: allow rendering specific decorators

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 $options = null) : void

Constructor

Parameters

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

__toString() : string

String representation of group

Returns

Type	Description
string

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

Instantiate a decorator based on class name or class name fragment

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

Lazy-load a decorator

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

Sort items according to their order

addAttribs(array $attribs) : \Zend_Form_DisplayGroup

Add multiple form attributes at once

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

Add a decorator for rendering the group

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

Add many decorators at once

Parameters

Name	Type	Description
$decorators	array

Returns

Type	Description
\Zend_Form_DisplayGroup

addElement(\Zend_Form_Element $element) : \Zend_Form_DisplayGroup

Add element to stack

Parameters

Name	Type	Description
$element	\Zend_Form_Element

Returns

Type	Description
\Zend_Form_DisplayGroup

addElements(array $elements) : \Zend_Form_DisplayGroup

Add multiple elements at once

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

Add a prefix path for the plugin loader

Parameters

Name	Type	Description
$prefix	string
$path	string

Returns

Type	Description
\Zend_Form_DisplayGroup

addPrefixPaths(array $spec) : \Zend_Form_DisplayGroup

Add several prefix paths at once

Parameters

Name	Type	Description
$spec	array

Returns

Type	Description
\Zend_Form_DisplayGroup

clearAttribs() : \Zend_Form

Clear all form attributes

Returns

Type	Description
\Zend_Form

clearDecorators() : \Zend_Form_DisplayGroup

Clear all decorators

Returns

Type	Description
\Zend_Form_DisplayGroup

clearElements() : \Zend_Form_DisplayGroup

Remove all elements

Returns

Type	Description
\Zend_Form_DisplayGroup

count() : int

Count of elements/subforms that are iterable

Returns

Type	Description
int

current() : \Zend_Form_Element

Current element

Returns

Type	Description
\Zend_Form_Element

filterName(string $value) : string

Filter a name to only allow valid variable characters

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
string

getAttrib(string $key) : mixed

Retrieve a single form attribute

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

getAttribs() : array

Retrieve all form attributes/metadata

Returns

Type	Description
array

getDecorator(string $name) : false | \Zend_Form_Decorator_Abstract

Retrieve a registered decorator

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
false \| \Zend_Form_Decorator_Abstract

getDecorators() : array

Retrieve all decorators

Returns

Type	Description
array

getDescription() : string

Get description

Returns

Type	Description
string

getElement(string $name) : \Zend_Form_Element | null

Retrieve element

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Form_Element \| null

getElements() : array

Retrieve elements

Returns

Type	Description
array

getForm() : \Zend_Form | null

Get form object to which the group is attached

Returns

Type	Description
\Zend_Form \| null

getFullyQualifiedName() : string

Get fully qualified name

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

Returns

Type	Description
string

getId() : string

Get element id

Returns

Type	Description
string

getLegend() : string

Retrieve group legend

Returns

Type	Description
string

getName() : string

Retrieve group name

Returns

Type	Description
string

getOrder() : int

Retrieve group order

Returns

Type	Description
int

getPluginLoader() : \Zend_Loader_PluginLoader

Retrieve plugin loader

Returns

Type	Description
\Zend_Loader_PluginLoader

getTranslator() : \Zend_Translate_Adapter | null

Retrieve translator object

Returns

Type	Description
\Zend_Translate_Adapter \| null

getView() : \Zend_View_Interface

Retrieve view

Returns

Type	Description
\Zend_View_Interface

hasTranslator() : bool

Does this display group have its own specific translator?

Returns

Type	Description
bool

init() : void

Initialize object; used by extending classes

key() : string

Current element

Returns

Type	Description
string

loadDefaultDecorators() : \Zend_Form_DisplayGroup

Load default decorators

Returns

Type	Description
\Zend_Form_DisplayGroup

loadDefaultDecoratorsIsDisabled() : bool

Should we load the default decorators?

Returns

Type	Description
bool

next() : void

Move pointer to next element

removeAttrib(string $key) : bool

Remove attribute

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
bool

removeDecorator(string $name) : bool

Remove a single decorator

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
bool

removeElement(string $name) : boolean

Remove a single element

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
boolean

render( $view = null) : string

Render display group

Parameters

Name	Type	Description
$view

Returns

Type	Description
string

rewind() : void

Move pointer to beginning of element loop

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

Set group attribute

Parameters

Name	Type	Description
$key	string
$value	mixed

Returns

Type	Description
\Zend_Form_DisplayGroup

setAttribs(array $attribs) : \Zend_Form_DisplayGroup

Set multiple form attributes at once

Overwrites any previously set attributes.

Parameters

Name	Type	Description
$attribs	array

Returns

Type	Description
\Zend_Form_DisplayGroup

setConfig(\Zend_Config $config) : \Zend_Form_DisplayGroup

Set options from config object

Parameters

Name	Type	Description
$config	\Zend_Config

Returns

Type	Description
\Zend_Form_DisplayGroup

setDecorators(array $decorators) : \Zend_Form_DisplayGroup

Overwrite all decorators

Parameters

Name	Type	Description
$decorators	array

Returns

Type	Description
\Zend_Form_DisplayGroup

setDescription(string $value) : \Zend_Form_DisplayGroup

Set description

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Form_DisplayGroup

setDisableLoadDefaultDecorators(bool $flag) : \Zend_Form_Element

Set flag to disable loading default decorators

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Form_Element

setDisableTranslator(bool $flag) : \Zend_Form_DisplayGroup

Indicate whether or not translation should be disabled

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Form_DisplayGroup

setElements(array $elements) : \Zend_Form_DisplayGroup

Set multiple elements at once (overwrites)

Parameters

Name	Type	Description
$elements	array

Returns

Type	Description
\Zend_Form_DisplayGroup

setForm(\Zend_Form $form) : \Zend_Form_DisplayGroup

Set form object to which the display group is attached

Parameters

Name	Type	Description
$form	\Zend_Form

Returns

Type	Description
\Zend_Form_DisplayGroup

setLegend(string $legend) : \Zend_Form_DisplayGroup

Set group legend

Parameters

Name	Type	Description
$legend	string

Returns

Type	Description
\Zend_Form_DisplayGroup

setName(string $name) : \Zend_Form_DisplayGroup

Set group name

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Form_DisplayGroup

setOptions(array $options) : \Zend_Form_DisplayGroup

Set options

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Form_DisplayGroup

setOrder(int $order) : \Zend_Form_Element

Set group order

Parameters

Name	Type	Description
$order	int

Returns

Type	Description
\Zend_Form_Element

setPluginLoader(\Zend_Loader_PluginLoader $loader) : \Zend_Form_DisplayGroup

Set plugin loader

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

Set translator object

Parameters

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

Returns

Type	Description
\Zend_Form_DisplayGroup

setView(\Zend_View_Interface $view = null) : \Zend_Form_DisplayGroup

Set view

Parameters

Name	Type	Description
$view	\Zend_View_Interface

Returns

Type	Description
\Zend_Form_DisplayGroup

translatorIsDisabled() : bool

Is translation disabled?

Returns

Type	Description
bool

valid() : bool

Determine if current element/subform/display group is valid

Returns

Type	Description
bool

Form/DisplayGroup.php

\Zend_Form_DisplayGroupjump to top

Properties

Methods

\Zend_Form_DisplayGroup
jump to top