API Documentation

Zend/Dojo/Form/Decorator/DijitElement.php

Show: inherited
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 24594 2012-01-05 21:27:01Z matthew $  

Properties

Propertyprotectedarray  $_attribs= ''

Element attributes

Details
Type
array
Propertyprotectedarray  $_buttonTypes= 'array( 'Zend_Dojo_Form_Element_Button''

Element types that represent buttons

Default valuearray( 'Zend_Dojo_Form_Element_Button'Details
Type
array
Propertyprotectedarray  $_dijitParams= 'array()'

Dijit option parameters

Default valuearray()Details
Type
array

Methods

methodpublicgetDijitParam( string $key ) : mixed|null

Retrieve a single dijit option parameter

Parameters
Name Type Description
$key string
Returns
Type Description
mixed|null
methodpublicgetDijitParams( ) : array

Get dijit option parameters

Returns
Type Description
array
methodpublicgetElementAttribs( ) : array

Get element attributes

Returns
Type Description
array
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
Name Type Description
$content string
Returns
Type Description
string
Throws
Exception Description
\Zend_Form_Decorator_Exception if element or view are not registered
methodpublicsetDijitParam( string $key, mixed $value ) : \Zend_Dojo_Form_Decorator_DijitContainer

Set a single dijit option parameter

Parameters
Name Type Description
$key string
$value mixed
Returns
Type Description
\Zend_Dojo_Form_Decorator_DijitContainer
methodpublicsetDijitParams( array $params ) : \Zend_Dojo_Form_Decorator_DijitContainer

Set dijit option parameters

Parameters
Name Type Description
$params array
Returns
Type Description
\Zend_Dojo_Form_Decorator_DijitContainer
Documentation was generated by DocBlox 0.15.1.