Zend_Form_Decorator_Description

Accepts the options:

  • separator: separator to use between label and content (defaults to PHP_EOL)
  • placement: whether to append or prepend label to content (defaults to prepend)
  • tag: if set, used to wrap the label in an additional HTML tag
  • class: if set, override default class used with HTML tag
  • escape: whether or not to escape description (true by default)

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

category Zend
package Zend_Form
subpackage Decorator
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
version $Id$
inherited_from \Zend_Form_Decorator_Abstract

 Methods

Constructor

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

Accept options during initialization.

inherited_from \Zend_Form_Decorator_Interface::__construct()

Parameters

$options

array\Zend_Config

Clear all options

clearOptions() : \Zend_Form_Decorator_Abstract
Inherited
inherited_from \Zend_Form_Decorator_Interface::clearOptions()

Returns

\Zend_Form_Decorator_Abstract

Get class with which to define description

getClass() : string

Defaults to 'hint'

Returns

string

Retrieve current element

getElement() : \Zend_Form_Element | \Zend_Form
Inherited
inherited_from \Zend_Form_Decorator_Interface::getElement()

Returns

\Zend_Form_Element\Zend_Form

Get escape flag

getEscape() : true

Returns

true

Get option

getOption(string $key) : mixed
Inherited
inherited_from \Zend_Form_Decorator_Interface::getOption()

Parameters

$key

string

Returns

mixed

Retrieve options

getOptions() : array
Inherited
inherited_from \Zend_Form_Decorator_Interface::getOptions()

Returns

array

Determine if decorator should append or prepend content

getPlacement() : string
Inherited

Returns

string

Retrieve separator to use between old and new content

getSeparator() : string
Inherited

Returns

string

Get HTML tag, if any, with which to surround description

getTag() : string

Returns

string

Remove single option

removeOption(mixed $key) : void
Inherited
inherited_from \Zend_Form_Decorator_Interface::removeOption()

Parameters

$key

mixed

Render a description

render(string $content) : string
inherited_from \Zend_Form_Decorator_Abstract::render()

Parameters

$content

string

Returns

string

Decorate content and/or element

render(string $content) : string
Inherited
inherited_from \Zend_Form_Decorator_Interface::render()

Parameters

$content

string

Exceptions

\Zend_Form_Decorator_Exception when unimplemented

Returns

string

Set options from config object

setConfig(\Zend_Config $config) : \Zend_Form_Decorator_Abstract
Inherited
inherited_from \Zend_Form_Decorator_Interface::setConfig()

Parameters

$config

\Zend_Config

Returns

\Zend_Form_Decorator_Abstract

Set current form element

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

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

inherited_from \Zend_Form_Decorator_Interface::setElement()

Parameters

$element

\Zend_Form_Element\Zend_Form

Exceptions

\Zend_Form_Decorator_Exception on invalid element type

Returns

\Zend_Form_Decorator_Abstract

Set whether or not to escape description

setEscape(boolean $flag) : \Zend_Form_Decorator_Description

Parameters

$flag

boolean

Returns

\Zend_Form_Decorator_Description

Set option

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

Parameters

$key

string

$value

mixed

Returns

\Zend_Form_Decorator_Abstract

Set options

setOptions(array $options) : \Zend_Form_Decorator_Abstract
Inherited
inherited_from \Zend_Form_Decorator_Interface::setOptions()

Parameters

$options

array

Returns

\Zend_Form_Decorator_Abstract

Set HTML tag with which to surround description

setTag(string $tag) : \Zend_Form_Decorator_Description

Parameters

$tag

string

Returns

\Zend_Form_Decorator_Description

 Properties

 

$_element

$_element : \Zend_Form_Element | \Zend_Form

Default

 

Whether or not to escape the description

$_escape : boolean

Default

 

Decorator options

$_options : array

Default

array()
 

Default placement: append

$_placement : string

Default

'APPEND'
inherited_from \Zend_Form_Decorator_Abstract::_placement
 

Default placement: append

$_placement : string

Default

'APPEND'
 

Separator between new content and old

$_separator : string

Default

PHP_EOL
 

HTML tag with which to surround description

$_tag : string

Default

 Constants

 

Placement constants

APPEND = 'APPEND' 
 

PREPEND

PREPEND = 'PREPEND'