Render a view script as a decorator
Accepts the options:
- separator: separator to use between view script content and provided content (defaults to PHP_EOL)
- placement: whether to append or prepend view script content to provided content (defaults to prepend)
- viewScript: view script to use
- viewModule: module that view script is in (optional)
The view script is rendered as a partial; the element being decorated is
passed in as the 'element' variable:
// in view script:
echo $this->element->getLabel();
Any options other than separator, placement, viewScript, and viewModule are passed to
the partial as local variables.
| 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
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 view script module
getViewModule() : string | null
Get view script
getViewScript() : string | null
Remove single option
removeOption(mixed $key) : void
Inherited
| inherited_from |
\Zend_Form_Decorator_Interface::removeOption() |
Parameters
$key
mixed
Render a view script
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 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 view script module
setViewModule($viewModule) : \Zend_Form_Decorator_ViewScript
Parameters
$viewModule
Returns
\Zend_Form_Decorator_ViewScript
Set view script
setViewScript(string $script) : \Zend_Form_Decorator_ViewScript
Parameters
$script
string
Returns
\Zend_Form_Decorator_ViewScript
Properties
$_element
$_element : \Zend_Form_Element | \Zend_Form
Decorator options
$_options : array
Default placement: append
$_placement : string
| inherited_from |
\Zend_Form_Decorator_Abstract::_placement |
Default placement: append
$_placement : string
Separator between new content and old
$_separator : string
View script module
$_viewModule : string
View script to render
$_viewScript : string
Constants
Placement constants
APPEND = 'APPEND'
PREPEND
PREPEND = 'PREPEND'