Decorate an element by using a view helper to render it.
Accepts the following options:
- separator: string with which to separate passed in content and generated content
- placement: whether to append or prepend the generated content to the passed in content
- helper: the name of the view helper to use
Assumes the view helper accepts three parameters, the name, value, and
optional attributes; these will be provided by the element.
| 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
Retrieve current element
getElement() : \Zend_Form_Element | \Zend_Form
Inherited
| inherited_from |
\Zend_Form_Decorator_Interface::getElement() |
Returns
\Zend_Form_Element\Zend_Form
Retrieve element attributes
getElementAttribs() : array
Set id to element name and/or array item.
Returns
array
Retrieve view helper for rendering element
getHelper() : string
Get name
getName() : string
If element is a Zend_Form_Element, will attempt to namespace it if the
element belongs to an array.
Returns
string
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
Retrieve separator to use between old and new content
getSeparator() : string
Inherited
Get value
getValue(\Zend_Form_Element $element) : string | null
If element type is one of the button types, returns the label.
Parameters
$element
\Zend_Form_Element
Returns
stringnull
Remove single option
removeOption(mixed $key) : void
Inherited
| inherited_from |
\Zend_Form_Decorator_Interface::removeOption() |
Parameters
$key
mixed
Render an element using a view helper
render(string $content) : string
Determine view helper from 'viewHelper' option, or, if none set, from
the element type. Then call as
helper($element->getName(), $element->getValue(), $element->getAttribs())
| inherited_from |
\Zend_Form_Decorator_Abstract::render() |
Parameters
$content
string
Exceptions
\Zend_Form_Decorator_Exception |
if element or view are not registered |
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 view helper to use when rendering
setHelper(string $helper) : \Zend_Form_Decorator_Element_ViewHelper
Parameters
$helper
string
Returns
\Zend_Form_Decorator_Element_ViewHelper
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
Properties
$_element
$_element : \Zend_Form_Element | \Zend_Form
View helper to use when rendering
$_helper : string
Decorator options
$_options : array
Default placement: append
$_placement : string
Separator between new content and old
$_separator : string
Constants
Placement constants
APPEND = 'APPEND'
PREPEND
PREPEND = 'PREPEND'