API Documentation

Form/Decorator/ViewScript.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Form  
subpackage
Decorator  

\Zend_Form_Decorator_ViewScript

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.

Extends from
\Zend_Form_Decorator_Abstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Form  
subpackage
Decorator  
version
$Id: ViewScript.php 23775 2011-03-01 17:25:24Z ralph $  

Properties

Propertyprotectedstring  $_placement= 'APPEND'

Default placement: append

Default valueAPPENDDetails
Type
string
Propertyprotectedstring  $_viewModule= ''

View script module

Details
Type
string
Propertyprotectedstring  $_viewScript= ''

View script to render

Details
Type
string

Methods

methodpublic__construct( array|\Zend_Config $options = null ) : void

Constructor

Inherited from: \Zend_Form_Decorator_Abstract::__construct()

Accept options during initialization.

Parameters
Name Type Description
$options array|\Zend_Config
methodpublicclearOptions( ) : \Zend_Form_Decorator_Abstract

Clear all options

Inherited from: \Zend_Form_Decorator_Abstract::clearOptions()
Returns
Type Description
\Zend_Form_Decorator_Abstract
methodpublicgetElement( ) : \Zend_Form_Element|\Zend_Form

Retrieve current element

Inherited from: \Zend_Form_Decorator_Abstract::getElement()
Returns
Type Description
\Zend_Form_Element\Zend_Form
methodpublicgetOption( string $key ) : mixed

Get option

Inherited from: \Zend_Form_Decorator_Abstract::getOption()
Parameters
Name Type Description
$key string
Returns
Type Description
mixed
methodpublicgetOptions( ) : array

Retrieve options

Inherited from: \Zend_Form_Decorator_Abstract::getOptions()
Returns
Type Description
array
methodpublicgetPlacement( ) : string

Determine if decorator should append or prepend content

Inherited from: \Zend_Form_Decorator_Abstract::getPlacement()
Returns
Type Description
string
methodpublicgetSeparator( ) : string

Retrieve separator to use between old and new content

Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()
Returns
Type Description
string
methodpublicgetViewModule( ) : string|null

Get view script module

Returns
Type Description
stringnull
methodpublicgetViewScript( ) : string|null

Get view script

Returns
Type Description
stringnull
methodpublicremoveOption( mixed $key ) : void

Remove single option

Inherited from: \Zend_Form_Decorator_Abstract::removeOption()
Parameters
Name Type Description
$key mixed
methodpublicrender( string $content ) : string

Render a view script

Parameters
Name Type Description
$content string
Returns
Type Description
string
Throws
Exception Description
\Zend_Form_Decorator_Exception when unimplemented
methodpublicsetConfig( \Zend_Config $config ) : \Zend_Form_Decorator_Abstract

Set options from config object

Inherited from: \Zend_Form_Decorator_Abstract::setConfig()
Parameters
Name Type Description
$config \Zend_Config
Returns
Type Description
\Zend_Form_Decorator_Abstract
methodpublicsetElement( \Zend_Form_Element|\Zend_Form $element ) : \Zend_Form_Decorator_Abstract

Set current form element

Inherited from: \Zend_Form_Decorator_Abstract::setElement()

While the name is "setElement", a form decorator could decorate either an element or a form object.

Parameters
Name Type Description
$element \Zend_Form_Element|\Zend_Form
Returns
Type Description
\Zend_Form_Decorator_Abstract
Throws
Exception Description
\Zend_Form_Decorator_Exception on invalid element type
methodpublicsetOption( string $key, mixed $value ) : \Zend_Form_Decorator_Abstract

Set option

Inherited from: \Zend_Form_Decorator_Abstract::setOption()
Parameters
Name Type Description
$key string
$value mixed
Returns
Type Description
\Zend_Form_Decorator_Abstract
methodpublicsetOptions( array $options ) : \Zend_Form_Decorator_Abstract

Set options

Inherited from: \Zend_Form_Decorator_Abstract::setOptions()
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Form_Decorator_Abstract
methodpublicsetViewModule(  $viewModule ) : \Zend_Form_Decorator_ViewScript

Set view script module

Parameters
Name Type Description
$viewModule
Returns
Type Description
\Zend_Form_Decorator_ViewScript
methodpublicsetViewScript( string $script ) : \Zend_Form_Decorator_ViewScript

Set view script

Parameters
Name Type Description
$script string
Returns
Type Description
\Zend_Form_Decorator_ViewScript
Documentation was generated by DocBlox 0.13.3.