Form/Decorator/Description.php
inherited
Classes
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 [email protected] 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_Description
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.
- Parent(s)
- \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: Description.php 24593 2012-01-05 20:35:02Z matthew $
Constants
PREPEND
= 'PREPEND'- Inherited_from
- \Zend_Form_Decorator_Abstract::PREPEND
Properties
\Zend_Form_Element|\Zend_Form $_element = - Type
- \Zend_Form_Element | \Zend_Form
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_element
bool $_escape = Whether or not to escape the description
- Type
- bool
array $_options = array()
array()Details- Type
- array
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_options
string $_placement = 'APPEND'Default placement: append
'APPEND'Details- Type
- string
string $_separator = PHP_EOLSeparator between new content and old
Inherited from: \Zend_Form_Decorator_Abstract::$$_separatorPHP_EOLDetails- Type
- string
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_separator
string $_tag = HTML tag with which to surround description
- Type
- string
Methods
__construct(array | \Zend_Config $options = null) : voidAccept options during initialization.
| Name | Type | Description |
|---|---|---|
| $options | array | \Zend_Config |
clearOptions() : \Zend_Form_Decorator_Abstract
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Abstract |
getClass() : stringGet class with which to define description
Defaults to 'hint'
| Type | Description |
|---|---|
| string |
getElement() : \Zend_Form_Element | \Zend_Form
| Type | Description |
|---|---|
| \Zend_Form_Element | \Zend_Form |
getEscape() : trueGet escape flag
| Type | Description |
|---|---|
| true |
getOption(string $key) : mixed
| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| mixed |
getOptions() : array
| Type | Description |
|---|---|
| array |
getPlacement() : stringDetermine if decorator should append or prepend content
Inherited from: \Zend_Form_Decorator_Abstract::getPlacement()| Type | Description |
|---|---|
| string |
getSeparator() : stringRetrieve separator to use between old and new content
Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()| Type | Description |
|---|---|
| string |
getTag() : stringGet HTML tag, if any, with which to surround description
| Type | Description |
|---|---|
| string |
removeOption(mixed $key) : void
| Name | Type | Description |
|---|---|---|
| $key | mixed |
render(string $content) : stringRender 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
| Name | Type | Description |
|---|---|---|
| $config | \Zend_Config |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Abstract |
setElement(\Zend_Form_Element | \Zend_Form $element) : \Zend_Form_Decorator_Abstract
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_DescriptionSet 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
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $value | mixed |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Abstract |
setOptions(array $options) : \Zend_Form_Decorator_Abstract
| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Abstract |
setTag(string $tag) : \Zend_Form_Decorator_DescriptionSet HTML tag with which to surround description
| Name | Type | Description |
|---|---|---|
| $tag | string |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Description |