Form/Decorator/ViewHelper.php

Show: PublicProtectedPrivateinherited
Table of Contents
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Form  

\Zend_Form_Decorator_ViewHelper

Package: Zend\Form\Decorator
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.

Parent(s)
\Zend_Form_Decorator_Abstract
Children
\Zend_Dojo_Form_Decorator_DijitElement
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Version
$Id: ViewHelper.php 25189 2013-01-08 08:32:43Z frosch $  

Constants

>VConstant  APPEND = 'APPEND'
inherited
Placement constants
Inherited from: \Zend_Form_Decorator_Abstract::APPEND
>VConstant  PREPEND = 'PREPEND'

Properties

>VPropertyprotectedarray $_buttonTypes = array('Zend_Form_Element_Button', 'Zend_Form_Element_Reset', 'Zend_Form_Element_Submit')
Element types that represent buttons
Default valuearray('Zend_Form_Element_Button', 'Zend_Form_Element_Reset', 'Zend_Form_Element_Submit')Details
Type
array
>VPropertyprotected\Zend_Form_Element|\Zend_Form $_element
>VPropertyprotectedstring $_helper
View helper to use when rendering
Details
Type
string
>VPropertyprotectedarray $_options = array()
inherited
Decorator options
Inherited from: \Zend_Form_Decorator_Abstract::$$_options
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Decorator_Abstract::$$_options  
>VPropertyprotectedstring $_placement = 'APPEND'
inherited
Default placement: append
Inherited from: \Zend_Form_Decorator_Abstract::$$_placement
Default value'APPEND'Details
Type
string
Inherited_from
\Zend_Form_Decorator_Abstract::$$_placement  
>VPropertyprotectedstring $_separator = PHP_EOL
inherited
Separator between new content and old
Inherited from: \Zend_Form_Decorator_Abstract::$$_separator
Default valuePHP_EOLDetails
Type
string
Inherited_from
\Zend_Form_Decorator_Abstract::$$_separator  

Methods

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

Constructor

Inherited from: \Zend_Form_Decorator_Abstract::__construct()

Accept options during initialization.

Parameters
NameTypeDescription
$optionsarray | \Zend_Config
methodpublicclearOptions() : \Zend_Form_Decorator_Abstract
inherited

Clear all options

Inherited from: \Zend_Form_Decorator_Abstract::clearOptions()
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicgetElement() : \Zend_Form_Element | \Zend_Form
inherited

Retrieve current element

Inherited from: \Zend_Form_Decorator_Abstract::getElement()
Returns
TypeDescription
\Zend_Form_Element | \Zend_Form
methodpublicgetElementAttribs() : array

Retrieve element attributes

Set id to element name and/or array item.

Returns
TypeDescription
array
methodpublicgetHelper() : string

Retrieve view helper for rendering element

Returns
TypeDescription
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
TypeDescription
string
methodpublicgetOption(string $key) : mixed
inherited

Get option

Inherited from: \Zend_Form_Decorator_Abstract::getOption()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublicgetOptions() : array
inherited

Retrieve options

Inherited from: \Zend_Form_Decorator_Abstract::getOptions()
Returns
TypeDescription
array
methodpublicgetPlacement() : string
inherited

Determine if decorator should append or prepend content

Inherited from: \Zend_Form_Decorator_Abstract::getPlacement()
Returns
TypeDescription
string
methodpublicgetSeparator() : string
inherited

Retrieve separator to use between old and new content

Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()
Returns
TypeDescription
string
methodpublicgetValue(\Zend_Form_Element $element) : string | null

Get value

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

Parameters
NameTypeDescription
$element\Zend_Form_Element
Returns
TypeDescription
string | null
methodpublicremoveOption(mixed $key) : void
inherited

Remove single option

Inherited from: \Zend_Form_Decorator_Abstract::removeOption()
Parameters
NameTypeDescription
$keymixed
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
NameTypeDescription
$contentstring
Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Form_Decorator_Exceptionif element or view are not registered
methodpublicsetConfig(\Zend_Config $config) : \Zend_Form_Decorator_Abstract
inherited

Set options from config object

Inherited from: \Zend_Form_Decorator_Abstract::setConfig()
Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicsetElement(\Zend_Form_Element | \Zend_Form $element) : \Zend_Form_Decorator_Abstract
inherited

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
NameTypeDescription
$element\Zend_Form_Element | \Zend_Form
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
Throws
ExceptionDescription
\Zend_Form_Decorator_Exceptionon invalid element type
methodpublicsetHelper(string $helper) : \Zend_Form_Decorator_Element_ViewHelper

Set view helper to use when rendering

Parameters
NameTypeDescription
$helperstring
Returns
TypeDescription
\Zend_Form_Decorator_Element_ViewHelper
methodpublicsetOption(string $key, mixed $value) : \Zend_Form_Decorator_Abstract
inherited

Set option

Inherited from: \Zend_Form_Decorator_Abstract::setOption()
Parameters
NameTypeDescription
$keystring
$valuemixed
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicsetOptions(array $options) : \Zend_Form_Decorator_Abstract
inherited

Set options

Inherited from: \Zend_Form_Decorator_Abstract::setOptions()
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
Documentation was generated by phpDocumentor 2.0.0a12.