Form/Decorator/ViewScript.php
Show:
inherited
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 license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Form
- Subpackage
- Decorator
\Zend_Form_Decorator_ViewScript
Package: Zend_Form\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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id$
Properties
string $_placement = 'APPEND'Default placement: append
Default value
'APPEND'Details- Type
- string
string $_viewModuleView script module
Details
- Type
- string
string $_viewScriptView script to render
Details
- Type
- string
Methods
getViewModule() : string | nullGet view script module
Returns
| Type | Description |
|---|---|
| string | null |
getViewScript() : string | nullGet view script
Returns
| Type | Description |
|---|---|
| string | null |
render(string $content) : stringRender a view script
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $content | string |
| Type | Description |
|---|---|
| string |
setViewModule( $viewModule) : \Zend_Form_Decorator_ViewScriptSet view script module
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $viewModule |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_ViewScript |
setViewScript(string $script) : \Zend_Form_Decorator_ViewScriptSet view script
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $script | string |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_ViewScript |