Dojo/Form/Decorator/DijitElement.php
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 [email protected] 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_Dojo_Form_Decorator_DijitElement
Zend_Dojo_Form_Decorator_DijitElement
Render a dojo dijit element via a view helper
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_ViewHelper < \Zend_Form_Decorator_Abstract
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id: DijitElement.php 24593 2012-01-05 20:35:02Z matthew $
Constants
APPEND
= 'APPEND'Placement constants
Inherited from: \Zend_Form_Decorator_Abstract::APPEND\Zend_Form_Decorator_ViewHelper::APPEND- Inherited_from
- \Zend_Form_Decorator_Abstract::APPEND
- Inherited_from
- \Zend_Form_Decorator_ViewHelper::APPEND
PREPEND
= 'PREPEND'- Inherited_from
- \Zend_Form_Decorator_Abstract::PREPEND
- Inherited_from
- \Zend_Form_Decorator_ViewHelper::PREPEND
Properties
array $_attribs = Element attributes
- Type
- array
array $_buttonTypes = array('Zend_Dojo_Form_Element_Button', 'Zend_Form_Element_Button', 'Zend_Form_Element_Reset', 'Zend_Form_Element_Submit')Element types that represent buttons
array('Zend_Dojo_Form_Element_Button', 'Zend_Form_Element_Button', 'Zend_Form_Element_Reset', 'Zend_Form_Element_Submit')Details- Type
- array
array $_dijitParams = array()Dijit option parameters
array()Details- Type
- array
\Zend_Form_Element|\Zend_Form $_element = - Type
- \Zend_Form_Element | \Zend_Form
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_element
- Inherited_from
- \Zend_Form_Decorator_ViewHelper::$$_element
string $_helper = View helper to use when rendering
Inherited from: \Zend_Form_Decorator_ViewHelper::$$_helper- Type
- string
- Inherited_from
- \Zend_Form_Decorator_ViewHelper::$$_helper
array $_options = array()Decorator options
Inherited from: \Zend_Form_Decorator_Abstract::$$_options\Zend_Form_Decorator_ViewHelper::$$_optionsarray()Details- Type
- array
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_options
- Inherited_from
- \Zend_Form_Decorator_ViewHelper::$$_options
string $_placement = 'APPEND'Default placement: append
Inherited from: \Zend_Form_Decorator_Abstract::$$_placement\Zend_Form_Decorator_ViewHelper::$$_placement'APPEND'Details- Type
- string
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_placement
- Inherited_from
- \Zend_Form_Decorator_ViewHelper::$$_placement
string $_separator = PHP_EOLSeparator between new content and old
Inherited from: \Zend_Form_Decorator_Abstract::$$_separator\Zend_Form_Decorator_ViewHelper::$$_separatorPHP_EOLDetails- Type
- string
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_separator
- Inherited_from
- \Zend_Form_Decorator_ViewHelper::$$_separator
Methods
__construct(array | \Zend_Config $options = null) : voidConstructor
Inherited from: \Zend_Form_Decorator_Abstract::__construct()\Zend_Form_Decorator_ViewHelper::__construct()Accept options during initialization.
| Name | Type | Description |
|---|---|---|
| $options | array | \Zend_Config |
clearOptions() : \Zend_Form_Decorator_AbstractClear all options
Inherited from: \Zend_Form_Decorator_Abstract::clearOptions()\Zend_Form_Decorator_ViewHelper::clearOptions()| Type | Description |
|---|---|
| \Zend_Form_Decorator_Abstract |
getDijitParam(string $key) : mixed | nullRetrieve a single dijit option parameter
| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| mixed | null |
getDijitParams() : arrayGet dijit option parameters
| Type | Description |
|---|---|
| array |
getElement() : \Zend_Form_Element | \Zend_FormRetrieve current element
Inherited from: \Zend_Form_Decorator_Abstract::getElement()\Zend_Form_Decorator_ViewHelper::getElement()| Type | Description |
|---|---|
| \Zend_Form_Element | \Zend_Form |
getElementAttribs() : arrayGet element attributes
Set id to element name and/or array item.
| Type | Description |
|---|---|
| array |
getHelper() : stringRetrieve view helper for rendering element
Inherited from: \Zend_Form_Decorator_ViewHelper::getHelper()| Type | Description |
|---|---|
| string |
getName() : string
If element is a Zend_Form_Element, will attempt to namespace it if the element belongs to an array.
| Type | Description |
|---|---|
| string |
getOption(string $key) : mixedGet option
Inherited from: \Zend_Form_Decorator_Abstract::getOption()\Zend_Form_Decorator_ViewHelper::getOption()| Name | Type | Description |
|---|---|---|
| $key | string |
| Type | Description |
|---|---|
| mixed |
getOptions() : arrayRetrieve options
Inherited from: \Zend_Form_Decorator_Abstract::getOptions()\Zend_Form_Decorator_ViewHelper::getOptions()| Type | Description |
|---|---|
| array |
getPlacement() : stringDetermine if decorator should append or prepend content
Inherited from: \Zend_Form_Decorator_Abstract::getPlacement()\Zend_Form_Decorator_ViewHelper::getPlacement()| Type | Description |
|---|---|
| string |
getSeparator() : stringRetrieve separator to use between old and new content
Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()\Zend_Form_Decorator_ViewHelper::getSeparator()| Type | Description |
|---|---|
| string |
getValue(\Zend_Form_Element $element) : string | null
If element type is one of the button types, returns the label.
| Name | Type | Description |
|---|---|---|
| $element | \Zend_Form_Element |
| Type | Description |
|---|---|
| string | null |
removeOption(mixed $key) : voidRemove single option
Inherited from: \Zend_Form_Decorator_Abstract::removeOption()\Zend_Form_Decorator_ViewHelper::removeOption()| Name | Type | Description |
|---|---|---|
| $key | mixed |
render(string $content) : stringRender an element using a view helper
Determine view helper from 'helper' option, or, if none set, from the element type. Then call as helper($element->getName(), $element->getValue(), $element->getAttribs())
| Name | Type | Description |
|---|---|---|
| $content | string |
| Type | Description |
|---|---|
| string |
| Exception | Description |
|---|---|
| \Zend_Form_Decorator_Exception | if element or view are not registered |
setConfig(\Zend_Config $config) : \Zend_Form_Decorator_AbstractSet options from config object
Inherited from: \Zend_Form_Decorator_Abstract::setConfig()\Zend_Form_Decorator_ViewHelper::setConfig()| Name | Type | Description |
|---|---|---|
| $config | \Zend_Config |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Abstract |
setDijitParam(string $key, mixed $value) : \Zend_Dojo_Form_Decorator_DijitContainerSet a single dijit option parameter
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $value | mixed |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Decorator_DijitContainer |
setDijitParams(array $params) : \Zend_Dojo_Form_Decorator_DijitContainerSet dijit option parameters
| Name | Type | Description |
|---|---|---|
| $params | array |
| Type | Description |
|---|---|
| \Zend_Dojo_Form_Decorator_DijitContainer |
setElement(\Zend_Form_Element | \Zend_Form $element) : \Zend_Form_Decorator_AbstractSet current form element
Inherited from: \Zend_Form_Decorator_Abstract::setElement()\Zend_Form_Decorator_ViewHelper::setElement()While the name is "setElement", a form decorator could decorate either an element or a form object.
| Name | Type | Description |
|---|---|---|
| $element | \Zend_Form_Element | \Zend_Form |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Abstract |
| Exception | Description |
|---|---|
| \Zend_Form_Decorator_Exception | on invalid element type |
setHelper(string $helper) : \Zend_Form_Decorator_Element_ViewHelperSet view helper to use when rendering
Inherited from: \Zend_Form_Decorator_ViewHelper::setHelper()| Name | Type | Description |
|---|---|---|
| $helper | string |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Element_ViewHelper |
setOption(string $key, mixed $value) : \Zend_Form_Decorator_AbstractSet option
Inherited from: \Zend_Form_Decorator_Abstract::setOption()\Zend_Form_Decorator_ViewHelper::setOption()| Name | Type | Description |
|---|---|---|
| $key | string | |
| $value | mixed |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Abstract |
setOptions(array $options) : \Zend_Form_Decorator_AbstractSet options
Inherited from: \Zend_Form_Decorator_Abstract::setOptions()\Zend_Form_Decorator_ViewHelper::setOptions()| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Form_Decorator_Abstract |