Zend Framework  1.12
Public Member Functions | Protected Attributes | List of all members
Zend_Form_Decorator_Description Class Reference

Public Member Functions

 setTag ($tag)
 Set HTML tag with which to surround description.
 
 getTag ()
 Get HTML tag, if any, with which to surround description.
 
 getClass ()
 Get class with which to define description.
 
 setEscape ($flag)
 Set whether or not to escape description.
 
 getEscape ()
 Get escape flag.
 
 render ($content)
 Render a description.
 
- Public Member Functions inherited from Zend_Form_Decorator_Abstract
 __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.
 

Protected Attributes

 $_escape
 
 $_placement = 'APPEND'
 
 $_tag
 
- Protected Attributes inherited from Zend_Form_Decorator_Abstract
 $_placement = 'APPEND'
 
 $_element
 
 $_options = array()
 
 $_separator = PHP_EOL
 

Additional Inherited Members

- Public Attributes inherited from Zend_Form_Decorator_Abstract
const APPEND = 'APPEND'
 Placement constants.
 
const PREPEND = 'PREPEND'
 

Member Function Documentation

getClass ( )

Get class with which to define description.

Defaults to 'hint'

Returns
string
getEscape ( )

Get escape flag.

Returns
true
getTag ( )

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

Returns
string
render (   $content)

Render a description.

Parameters
string$content
Returns
string

Implements Zend_Form_Decorator_Interface.

setEscape (   $flag)

Set whether or not to escape description.

Parameters
bool$flag
Returns
Zend_Form_Decorator_Description
setTag (   $tag)

Set HTML tag with which to surround description.

Parameters
string$tag
Returns
Zend_Form_Decorator_Description

Member Data Documentation

$_escape
protected
$_placement = 'APPEND'
protected
$_tag
protected