Form/Decorator/PrepareElements.php

Show:

inherited

Classes
- \Zend_Form_Decorator_PrepareElements

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_Form
Subpackage: Decorator

\Zend_Form_Decorator_PrepareElements
jump to top

Package: Zend\Form\Decorator

Zend_Form_Decorator_PrepareElements

Render all form elements registered with current form

Accepts following options: - separator: Separator to use between elements

Any other options passed will be used as HTML attributes of the form tag.

Parent(s): \Zend_Form_Decorator_FormElements < \Zend_Form_Decorator_Abstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Version: $Id: PrepareElements.php 24593 2012-01-05 20:35:02Z matthew $

Constants

 
                APPEND
                = 'APPEND'

inherited

Placement constants

Inherited from: \Zend_Form_Decorator_Abstract::APPEND \Zend_Form_Decorator_FormElements::APPEND

Inherited_from: \Zend_Form_Decorator_Abstract::APPEND
Inherited_from: \Zend_Form_Decorator_FormElements::APPEND

 
                PREPEND
                = 'PREPEND'

inheritedInherited from: \Zend_Form_Decorator_Abstract::PREPEND \Zend_Form_Decorator_FormElements::PREPEND

Inherited_from: \Zend_Form_Decorator_Abstract::PREPEND
Inherited_from: \Zend_Form_Decorator_FormElements::PREPEND

Properties

\Zend_Form_Element|\Zend_Form $_element

inherited

Inherited from: \Zend_Form_Decorator_Abstract::$$_element \Zend_Form_Decorator_FormElements::$$_element

Details

Type: \Zend_Form_Element | \Zend_Form
Inherited_from: \Zend_Form_Decorator_Abstract::$$_element
Inherited_from: \Zend_Form_Decorator_FormElements::$$_element

array $_options = array()

inherited

Decorator options

Inherited from: \Zend_Form_Decorator_Abstract::$$_options \Zend_Form_Decorator_FormElements::$$_options

Default valuearray()Details

Type: array
Inherited_from: \Zend_Form_Decorator_Abstract::$$_options
Inherited_from: \Zend_Form_Decorator_FormElements::$$_options

string $_placement = 'APPEND'

inherited

Default placement: append

Inherited from: \Zend_Form_Decorator_Abstract::$$_placement \Zend_Form_Decorator_FormElements::$$_placement

Default value'APPEND'Details

Type: string
Inherited_from: \Zend_Form_Decorator_Abstract::$$_placement
Inherited_from: \Zend_Form_Decorator_FormElements::$$_placement

string $_separator = PHP_EOL

inherited

Separator between new content and old

Inherited from: \Zend_Form_Decorator_Abstract::$$_separator \Zend_Form_Decorator_FormElements::$$_separator

Default valuePHP_EOLDetails

Type: string
Inherited_from: \Zend_Form_Decorator_Abstract::$$_separator
Inherited_from: \Zend_Form_Decorator_FormElements::$$_separator

Methods

__construct(array | \Zend_Config $options = null) : void

inherited

Constructor

Inherited from: \Zend_Form_Decorator_Abstract::__construct()\Zend_Form_Decorator_FormElements::__construct()

Accept options during initialization.

Parameters

Name	Type	Description
$options	array \| \Zend_Config

_recursivelyPrepareForm( $form) : void

Parameters

Name	Type	Description
$form

clearOptions() : \Zend_Form_Decorator_Abstract

inherited

Clear all options

Inherited from: \Zend_Form_Decorator_Abstract::clearOptions()\Zend_Form_Decorator_FormElements::clearOptions()

Returns

Type	Description
\Zend_Form_Decorator_Abstract

getElement() : \Zend_Form_Element | \Zend_Form

inherited

Retrieve current element

Inherited from: \Zend_Form_Decorator_Abstract::getElement()\Zend_Form_Decorator_FormElements::getElement()

Returns

Type	Description
\Zend_Form_Element \| \Zend_Form

getOption(string $key) : mixed

inherited

Get option

Inherited from: \Zend_Form_Decorator_Abstract::getOption()\Zend_Form_Decorator_FormElements::getOption()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

getOptions() : array

inherited

Retrieve options

Inherited from: \Zend_Form_Decorator_Abstract::getOptions()\Zend_Form_Decorator_FormElements::getOptions()

Returns

Type	Description
array

getPlacement() : string

inherited

Determine if decorator should append or prepend content

Inherited from: \Zend_Form_Decorator_Abstract::getPlacement()\Zend_Form_Decorator_FormElements::getPlacement()

Returns

Type	Description
string

getSeparator() : string

inherited

Retrieve separator to use between old and new content

Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()\Zend_Form_Decorator_FormElements::getSeparator()

Returns

Type	Description
string

mergeBelongsTo(string $baseBelongsTo, string $belongsTo) : string

inherited

Merges given two belongsTo (array notation) strings

Inherited from: \Zend_Form_Decorator_FormElements::mergeBelongsTo()

Parameters

Name	Type	Description
$baseBelongsTo	string
$belongsTo	string

Returns

Type	Description
string

removeOption(mixed $key) : void

inherited

Remove single option

Inherited from: \Zend_Form_Decorator_Abstract::removeOption()\Zend_Form_Decorator_FormElements::removeOption()

Parameters

Name	Type	Description
$key	mixed

render(string $content) : string

Render form elements

Parameters

Name	Type	Description
$content	string

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Form_Decorator_Exception	when unimplemented

setConfig(\Zend_Config $config) : \Zend_Form_Decorator_Abstract

inherited

Set options from config object

Inherited from: \Zend_Form_Decorator_Abstract::setConfig()\Zend_Form_Decorator_FormElements::setConfig()

Parameters

Name	Type	Description
$config	\Zend_Config

Returns

Type	Description
\Zend_Form_Decorator_Abstract

setElement(\Zend_Form_Element | \Zend_Form $element) : \Zend_Form_Decorator_Abstract

inherited

Set current form element

Inherited from: \Zend_Form_Decorator_Abstract::setElement()\Zend_Form_Decorator_FormElements::setElement()

While the name is "setElement", a form decorator could decorate either an element or a form object.

Parameters

Name	Type	Description
$element	\Zend_Form_Element \| \Zend_Form

Returns

Type	Description
\Zend_Form_Decorator_Abstract

Throws

Exception	Description
\Zend_Form_Decorator_Exception	on invalid element type

setOption(string $key, mixed $value) : \Zend_Form_Decorator_Abstract

inherited

Set option

Inherited from: \Zend_Form_Decorator_Abstract::setOption()\Zend_Form_Decorator_FormElements::setOption()

Parameters

Name	Type	Description
$key	string
$value	mixed

Returns

Type	Description
\Zend_Form_Decorator_Abstract

setOptions(array $options) : \Zend_Form_Decorator_Abstract

inherited

Set options

Inherited from: \Zend_Form_Decorator_Abstract::setOptions()\Zend_Form_Decorator_FormElements::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Form_Decorator_Abstract

Form/Decorator/PrepareElements.php

\Zend_Form_Decorator_PrepareElementsjump to top

Constants

Properties

Methods

\Zend_Form_Decorator_PrepareElements
jump to top