Zend_Form_Decorator_Abstract Class Reference

Public Member Functions
	__construct ($options=null)
	Constructor.
	setOptions (array $options)
	Set options.
	setConfig (Zend_Config $config)
	Set options from config object.
	setOption ($key, $value)
	Set option.
	getOption ($key)
	Get option.
	getOptions ()
	Retrieve options.
	removeOption ($key)
	Remove single option.
	clearOptions ()
	Clear all options.
	setElement ($element)
	Set current form element.
	getElement ()
	Retrieve current element.
	getPlacement ()
	Determine if decorator should append or prepend content.
	getSeparator ()
	Retrieve separator to use between old and new content.
	render ($content)
	Decorate content and/or element.

Public Attributes
const	APPEND = 'APPEND'
	Placement constants.
const	PREPEND = 'PREPEND'

Protected Attributes
	$_placement = 'APPEND'
	$_element
	$_options = array()
	$_separator = PHP_EOL

Constructor & Destructor Documentation

__construct

(

$options = null

)

Constructor.

Parameters

array | Zend_Config

$options

Returns

void

Implements Zend_Form_Decorator_Interface.

Member Function Documentation

clearOptions

(

)

Clear all options.

Returns

Zend_Form_Decorator_Abstract

Implements Zend_Form_Decorator_Interface.

getElement

(

)

Retrieve current element.

Returns

Zend_Form_Element|Zend_Form

Implements Zend_Form_Decorator_Interface.

getOption

(

$key

)

Get option.

Parameters

string

$key

Returns

mixed

Implements Zend_Form_Decorator_Interface.

getOptions

(

)

Retrieve options.

Returns

array

Implements Zend_Form_Decorator_Interface.

getPlacement

(

)

Determine if decorator should append or prepend content.

Returns

string

getSeparator

(

)

Retrieve separator to use between old and new content.

Returns

string

removeOption

(

$key

)

Remove single option.

Parameters

mixed

$key

Returns

void

Implements Zend_Form_Decorator_Interface.

render

(

$content

)

Decorate content and/or element.

Parameters

string

$content

Returns

string

Exceptions

Zend_Form_Decorator_Exception

when unimplemented

Implements Zend_Form_Decorator_Interface.

setConfig

(

Zend_Config

$config

)

Set options from config object.

Parameters

Zend_Config

$config

Returns

Zend_Form_Decorator_Abstract

Implements Zend_Form_Decorator_Interface.

setElement

(

$element

)

Set current form element.

Parameters

Zend_Form_Element | Zend_Form

$element

Returns

Zend_Form_Decorator_Abstract

Exceptions

Zend_Form_Decorator_Exception

on invalid element type

Implements Zend_Form_Decorator_Interface.

setOption	(		$key,
			$value
	)

Set option.

Parameters

string	$key
mixed	$value

Returns

Zend_Form_Decorator_Abstract

Implements Zend_Form_Decorator_Interface.

setOptions

(

array

$options

)

Set options.

Parameters

array

$options

Returns

Zend_Form_Decorator_Abstract

Implements Zend_Form_Decorator_Interface.

Member Data Documentation

$_element

protected

$_options = array()

protected

$_placement = 'APPEND'

protected

$_separator = PHP_EOL

protected

const APPEND = 'APPEND'

Placement constants.

const PREPEND = 'PREPEND'