Dojo/Form/Decorator/DijitElement.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_Dojo_Form_Decorator_DijitElement

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

Properties

>VPropertyprotectedarray $_attribs
Element attributes
Details
Type
array
>VPropertyprotectedarray $_buttonTypes = array('Zend_Dojo_Form_Element_Button', 'Zend_Form_Element_Button', 'Zend_Form_Element_Reset', 'Zend_Form_Element_Submit')
Element types that represent buttons
Default valuearray('Zend_Dojo_Form_Element_Button', 'Zend_Form_Element_Button', 'Zend_Form_Element_Reset', 'Zend_Form_Element_Submit')Details
Type
array
>VPropertyprotectedarray $_dijitParams = array()
Dijit option parameters
Default valuearray()Details
Type
array
>VPropertyprotectedstring $_helper
inherited
View helper to use when rendering
Inherited from: \Zend_Form_Decorator_ViewHelper::$$_helper
Details
Type
string
Inherited_from
\Zend_Form_Decorator_ViewHelper::$$_helper  
>VPropertyprotectedarray $_options = array()
Default valuearray()Details
Type
array
Inherited_from
\Zend_Form_Decorator_Abstract::$$_options  
Inherited_from
\Zend_Form_Decorator_ViewHelper::$$_options  
>VPropertyprotectedstring $_placement = 'APPEND'
Default value'APPEND'Details
Type
string
Inherited_from
\Zend_Form_Decorator_Abstract::$$_placement  
Inherited_from
\Zend_Form_Decorator_ViewHelper::$$_placement  
>VPropertyprotectedstring $_separator = PHP_EOL
inherited
Separator between new content and old
Inherited from: \Zend_Form_Decorator_Abstract::$$_separator\Zend_Form_Decorator_ViewHelper::$$_separator
Default valuePHP_EOLDetails
Type
string
Inherited_from
\Zend_Form_Decorator_Abstract::$$_separator  
Inherited_from
\Zend_Form_Decorator_ViewHelper::$$_separator  

Methods

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

Accept options during initialization.

Parameters
NameTypeDescription
$optionsarray | \Zend_Config
methodpublicgetDijitParam(string $key) : mixed | null

Retrieve a single dijit option parameter

Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed | null
methodpublicgetDijitParams() : array

Get dijit option parameters

Returns
TypeDescription
array
methodpublicgetElementAttribs() : array

Get element attributes

Set id to element name and/or array item.

Returns
TypeDescription
array
methodpublicgetHelper() : string
inherited

Retrieve view helper for rendering element

Inherited from: \Zend_Form_Decorator_ViewHelper::getHelper()
Returns
TypeDescription
string
methodpublicgetName() : string
inherited

Get name

Inherited from: \Zend_Form_Decorator_ViewHelper::getName()

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
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublicgetOptions() : array
Returns
TypeDescription
array
methodpublicgetPlacement() : string
inherited

Determine if decorator should append or prepend content

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

Retrieve separator to use between old and new content

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

Get value

Inherited from: \Zend_Form_Decorator_ViewHelper::getValue()

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
Parameters
NameTypeDescription
$keymixed
methodpublicrender(string $content) : string

Render 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())

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
Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicsetDijitParam(string $key, mixed $value) : \Zend_Dojo_Form_Decorator_DijitContainer

Set a single dijit option parameter

Parameters
NameTypeDescription
$keystring
$valuemixed
Returns
TypeDescription
\Zend_Dojo_Form_Decorator_DijitContainer
methodpublicsetDijitParams(array $params) : \Zend_Dojo_Form_Decorator_DijitContainer

Set dijit option parameters

Parameters
NameTypeDescription
$paramsarray
Returns
TypeDescription
\Zend_Dojo_Form_Decorator_DijitContainer
methodpublicsetElement(\Zend_Form_Element | \Zend_Form $element) : \Zend_Form_Decorator_Abstract

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
inherited

Set view helper to use when rendering

Inherited from: \Zend_Form_Decorator_ViewHelper::setHelper()
Parameters
NameTypeDescription
$helperstring
Returns
TypeDescription
\Zend_Form_Decorator_Element_ViewHelper
methodpublicsetOption(string $key, mixed $value) : \Zend_Form_Decorator_Abstract
Parameters
NameTypeDescription
$keystring
$valuemixed
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
methodpublicsetOptions(array $options) : \Zend_Form_Decorator_Abstract
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Form_Decorator_Abstract
Documentation was generated by phpDocumentor 2.0.0a12.