API Documentation

Form/Decorator/ViewHelper.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  

\Zend_Form_Decorator_ViewHelper

Zend_Form_Decorator_ViewHelper

Decorate an element by using a view helper to render it.

Accepts the following options: - separator: string with which to separate passed in content and generated content - placement: whether to append or prepend the generated content to the passed in content - helper: the name of the view helper to use

Assumes the view helper accepts three parameters, the name, value, and optional attributes; these will be provided by the element.

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: ViewHelper.php 23775 2011-03-01 17:25:24Z ralph $  

Properties

Propertyprotectedarray  $_buttonTypes= 'array'

Element types that represent buttons

Default valuearrayDetails
Type
array
Propertyprotectedstring  $_helper= ''

View helper to use when rendering

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
methodpublicgetElementAttribs( ) : array

Retrieve element attributes

Set id to element name and/or array item.

Returns
Type Description
array
methodpublicgetHelper( ) : string

Retrieve view helper for rendering element

Returns
Type Description
string
methodpublicgetName( ) : string

Get name

If element is a Zend_Form_Element, will attempt to namespace it if the element belongs to an array.

Returns
Type Description
string
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
methodpublicgetValue( \Zend_Form_Element $element ) : string|null

Get value

If element type is one of the button types, returns the label.

Parameters
Name Type Description
$element \Zend_Form_Element
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 an element using a view helper

Determine view helper from 'viewHelper' option, or, if none set, from the element type. Then call as helper($element->getName(), $element->getValue(), $element->getAttribs())

Parameters
Name Type Description
$content string
Returns
Type Description
string
Throws
Exception Description
\Zend_Form_Decorator_Exception if element or view are not registered
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
methodpublicsetHelper( string $helper ) : \Zend_Form_Decorator_Element_ViewHelper

Set view helper to use when rendering

Parameters
Name Type Description
$helper string
Returns
Type Description
\Zend_Form_Decorator_Element_ViewHelper
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
Documentation was generated by DocBlox 0.13.3.