Form/Decorator/ViewHelper.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
\Zend_Form_Decorator_ViewHelper
Package: Zend_Form\Decorator
Returns
Returns
Throws
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id$
Properties
array $_buttonTypes = array('Zend_Form_Element_Button', 'Zend_Form_Element_Reset', 'Zend_Form_Element_Submit')Element types that represent buttons
Default value
array('Zend_Form_Element_Button', 'Zend_Form_Element_Reset', 'Zend_Form_Element_Submit')Details- Type
- array
string $_helperView helper to use when rendering
Details
- Type
- string
Methods
getElementAttribs() : arrayRetrieve element attributes
Set id to element name and/or array item.
Returns| Type | Description |
|---|---|
| array |
getHelper() : stringRetrieve view helper for rendering element
Returns
| Type | Description |
|---|---|
| string |
getName() : stringGet name
If element is a Zend_Form_Element, will attempt to namespace it if the
element belongs to an array.
Returns| Type | Description |
|---|---|
| string |
getValue(\Zend_Form_Element $element) : string | nullGet value
If element type is one of the button types, returns the label.
Parameters| Name | Type | Description |
|---|---|---|
| $element | \Zend_Form_Element |
| Type | Description |
|---|---|
| string | null |
render(string $content) : stringRender 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 |
| Type | Description |
|---|---|
| string |
| Exception | Description |
|---|---|
| \Zend_Form_Decorator_Exception | if element or view are not registered |
setHelper(string $helper) : \Zend_Form_Decorator_Element_ViewHelperSet view helper to use when rendering
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $helper | string |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Element_ViewHelper |