Docs For Class Zend_Form_Decorator

Description

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

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, and viewScript are passed to the partial as local variables.

version: $Id: ViewScript.php 20096 2010-01-06 02:05:09Z bkarwin $
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /Form/Decorator/ViewScript.php (line 52)

Zend_Form_Decorator_Abstract
   |
   --Zend_Form_Decorator_ViewScript

Variable Summary

string $_placement

string $_viewScript

Method Summary

string|null getViewScript ()

string render (string $content)

Zend_Form_Decorator_ViewScript setViewScript (string $script)

Variables

string $_placement = 'APPEND' (line 58)

Default placement: append

access: protected

Redefinition of:

Zend_Form_Decorator_Abstract::$_placement: Default placement: append

string $_viewScript (line 64)

View script to render

access: protected

Inherited Variables

Inherited from Zend_Form_Decorator_Abstract

Zend_Form_Decorator_Abstract::$_element
Zend_Form_Decorator_Abstract::$_options
Zend_Form_Decorator_Abstract::$_separator

Methods

getViewScript (line 83)

Get view script

access: public

string|null getViewScript ()

render (line 108)

Render a view script

access: public

string render (string $content)

string $content

Redefinition of:

Zend_Form_Decorator_Abstract::render(): Decorate content and/or element

setViewScript (line 72)

Set view script

access: public

Zend_Form_Decorator_ViewScript setViewScript (string $script)

string $script

Inherited Methods

Inherited From Zend_Form_Decorator_Abstract

Zend_Form_Decorator_Abstract::__construct()
Zend_Form_Decorator_Abstract::clearOptions()
Zend_Form_Decorator_Abstract::getElement()
Zend_Form_Decorator_Abstract::getOption()
Zend_Form_Decorator_Abstract::getOptions()
Zend_Form_Decorator_Abstract::getPlacement()
Zend_Form_Decorator_Abstract::getSeparator()
Zend_Form_Decorator_Abstract::removeOption()
Zend_Form_Decorator_Abstract::render()
Zend_Form_Decorator_Abstract::setConfig()
Zend_Form_Decorator_Abstract::setElement()
Zend_Form_Decorator_Abstract::setOption()
Zend_Form_Decorator_Abstract::setOptions()

Class Constants

Inherited Constants

Inherited from Zend_Form_Decorator_Abstract

Zend_Form_Decorator_Abstract::APPEND
Zend_Form_Decorator_Abstract::PREPEND