Form/Decorator/ViewScript.php
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.
- 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_ViewScript
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.
- 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: ViewScript.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


array $_options = array()
array()
Details- Type
- array
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_options


string $_separator = PHP_EOL
PHP_EOL
Details- Type
- string
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_separator
Methods


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


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 |


render(string $content) : string
Render a view script
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 |


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 |


setViewModule( $viewModule) : \Zend_Form_Decorator_ViewScript
Set view script module
Name | Type | Description |
---|---|---|
$viewModule |
Type | Description |
---|---|
\Zend_Form_Decorator_ViewScript |


setViewScript(string $script) : \Zend_Form_Decorator_ViewScript
Set view script
Name | Type | Description |
---|---|---|
$script | string |
Type | Description |
---|---|
\Zend_Form_Decorator_ViewScript |