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.
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.

__construct(
array|\Zend_Config $options
=
null
)
:
void
Constructor
Inherited from: \Zend_Form_Decorator_Abstract::__construct()Accept options during initialization.
Name | Type | Description |
---|---|---|
$options | array|\Zend_Config |

clearOptions(
)
:
\Zend_Form_Decorator_Abstract
Clear all options
Inherited from: \Zend_Form_Decorator_Abstract::clearOptions()Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |

getClass(
)
:
string
Get class with which to define description
Defaults to 'hint'
Type | Description |
---|---|
string |

getElement(
)
:
\Zend_Form_Element|\Zend_Form
Retrieve current element
Inherited from: \Zend_Form_Decorator_Abstract::getElement()Type | Description |
---|---|
\Zend_Form_Element\Zend_Form |

getOption(
string $key
)
:
mixed
Get option
Inherited from: \Zend_Form_Decorator_Abstract::getOption()Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |

getOptions(
)
:
array
Retrieve options
Inherited from: \Zend_Form_Decorator_Abstract::getOptions()Type | Description |
---|---|
array |

getPlacement(
)
:
string
Determine if decorator should append or prepend content
Inherited from: \Zend_Form_Decorator_Abstract::getPlacement()Type | Description |
---|---|
string |

getSeparator(
)
:
string
Retrieve separator to use between old and new content
Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()Type | Description |
---|---|
string |

getTag(
)
:
string
Get HTML tag, if any, with which to surround description
Type | Description |
---|---|
string |

removeOption(
mixed $key
)
:
void
Remove single option
Inherited from: \Zend_Form_Decorator_Abstract::removeOption()Name | Type | Description |
---|---|---|
$key | mixed |

render(
string $content
)
:
string
Render a description
Name | Type | Description |
---|---|---|
$content | string |
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Form_Decorator_Exception | when unimplemented |

setConfig(
\Zend_Config $config
)
:
\Zend_Form_Decorator_Abstract
Set options from config object
Inherited from: \Zend_Form_Decorator_Abstract::setConfig()Name | Type | Description |
---|---|---|
$config | \Zend_Config |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |

setElement(
\Zend_Form_Element|\Zend_Form $element
)
:
\Zend_Form_Decorator_Abstract
Set current form element
Inherited from: \Zend_Form_Decorator_Abstract::setElement()While the name is "setElement", a form decorator could decorate either an element or a form object.
Name | Type | Description |
---|---|---|
$element | \Zend_Form_Element|\Zend_Form |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |
Exception | Description |
---|---|
\Zend_Form_Decorator_Exception | on invalid element type |

setEscape(
bool $flag
)
:
\Zend_Form_Decorator_Description
Set whether or not to escape description
Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_Form_Decorator_Description |

setOption(
string $key, mixed $value
)
:
\Zend_Form_Decorator_Abstract
Set option
Inherited from: \Zend_Form_Decorator_Abstract::setOption()Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |

setOptions(
array $options
)
:
\Zend_Form_Decorator_Abstract
Set options
Inherited from: \Zend_Form_Decorator_Abstract::setOptions()Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |

setTag(
string $tag
)
:
\Zend_Form_Decorator_Description
Set HTML tag with which to surround description
Name | Type | Description |
---|---|---|
$tag | string |
Type | Description |
---|---|
\Zend_Form_Decorator_Description |