Dojo/View/Helper/CustomDijit.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_Dojo  
Subpackage
View  
Version
$Id: CustomDijit.php 25024 2012-07-30 15:08:15Z rob $  

\Zend_Dojo_View_Helper_CustomDijit

Package: Zend\Dojo\View
Arbitrary dijit support
Parent(s)
\Zend_Dojo_View_Helper_DijitContainer < \Zend_Dojo_View_Helper_Dijit < \Zend_View_Helper_HtmlElement < \Zend_View_Helper_Abstract
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
\global\Zend_Dojo_View_Helper_DijitContainer  

Constants

Properties

>VPropertyprotectedarray $_captureInfo = array()
inherited
Metadata information to use with captured content
Inherited from: \Zend_Dojo_View_Helper_DijitContainer::$$_captureInfo
Default valuearray()Details
Type
array
Inherited_from
\Zend_Dojo_View_Helper_DijitContainer::$$_captureInfo  
>VPropertyprotectedarray $_captureLock = array()
inherited
Capture locks
Inherited from: \Zend_Dojo_View_Helper_DijitContainer::$$_captureLock
Default valuearray()Details
Type
array
Inherited_from
\Zend_Dojo_View_Helper_DijitContainer::$$_captureLock  
>VPropertyprotectedstring $_defaultDojoType
Default dojoType; set the value when extending
Details
Type
string
>VPropertyprotectedarray $_jsonParams = array('constraints')
Default valuearray('constraints')Details
Type
array
Inherited_from
\Zend_Dojo_View_Helper_Dijit::$$_jsonParams  
Inherited_from
\Zend_Dojo_View_Helper_DijitContainer::$$_jsonParams  
>VPropertyprotectedstring $_rootNode = 'div'
inherited
Root node element type for layout elements
Inherited from: \Zend_Dojo_View_Helper_Dijit::$$_rootNode\Zend_Dojo_View_Helper_DijitContainer::$$_rootNode
Default value'div'Details
Type
string
Inherited_from
\Zend_Dojo_View_Helper_Dijit::$$_rootNode  
Inherited_from
\Zend_Dojo_View_Helper_DijitContainer::$$_rootNode  

Methods

methodprotected_castBoolToString(mixed $item, string $key) : void
Parameters
NameTypeDescription
$itemmixed
$keystring
methodprotected_createDijit(string $dijit, string $id, array $params) : void
Parameters
NameTypeDescription
$dijitstring
$idstring
$paramsarray
methodpublic_createFormElement(string $id, string $value, array $params, array $attribs, string | null $dijit = null) : string
inherited

Create HTML representation of a dijit form element

Inherited from: \Zend_Dojo_View_Helper_Dijit::_createFormElement()\Zend_Dojo_View_Helper_DijitContainer::_createFormElement()
Parameters
NameTypeDescription
$idstring
$valuestring
$paramsarray
$attribsarray
$dijitstring | null
Returns
TypeDescription
string
methodprotected_createGetParentFormFunction() : void
methodprotected_createLayoutContainer(int $id, string $content, array $params, array $attribs, string | null $dijit = null) : string
Parameters
NameTypeDescription
$idint
$contentstring
$paramsarray
$attribsarray
$dijitstring | null
Returns
TypeDescription
string
methodprotected_htmlAttribs(array $attribs) : string
Parameters
NameTypeDescription
$attribsarray

From this array, each key-value pair is converted to an attribute name and value.

Returns
TypeDescription
stringThe XHTML for the attributes.
Details
Access
public  
methodprotected_isXhtml() : boolean
Returns
TypeDescription
boolean
methodprotected_normalizeId(string $value) : string
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
string
methodprotected_prepareDijit(array $attribs, array $params, string $type, string $dijit = null) : array

Also sets up requires

Parameters
NameTypeDescription
$attribsarray
$paramsarray
$typestring
$dijitstring

Dijit type to use (otherwise, pull from $_dijit)

Returns
TypeDescription
array
methodprotected_renderHiddenElement(string $id, string | int | float $value) : string
Parameters
NameTypeDescription
$idstring
$valuestring | int | float
Returns
TypeDescription
string
methodprotected_useDeclarative() : bool
inherited

Whether or not to use declarative dijit creation

Inherited from: \Zend_Dojo_View_Helper_Dijit::_useDeclarative()\Zend_Dojo_View_Helper_DijitContainer::_useDeclarative()
Returns
TypeDescription
bool
methodprotected_useProgrammatic() : bool
inherited

Whether or not to use programmatic dijit creation

Inherited from: \Zend_Dojo_View_Helper_Dijit::_useProgrammatic()\Zend_Dojo_View_Helper_DijitContainer::_useProgrammatic()
Returns
TypeDescription
bool
methodprotected_useProgrammaticNoScript() : bool
inherited

Whether or not to use programmatic dijit creation w/o script creation

Inherited from: \Zend_Dojo_View_Helper_Dijit::_useProgrammaticNoScript()\Zend_Dojo_View_Helper_DijitContainer::_useProgrammaticNoScript()
Returns
TypeDescription
bool
methodpubliccaptureEnd(string $id) : string
inherited

Finish capturing content for layout container

Inherited from: \Zend_Dojo_View_Helper_DijitContainer::captureEnd()
Parameters
NameTypeDescription
$idstring
Returns
TypeDescription
string
methodpubliccaptureStart(string $id, array $params = array(), array $attribs = array()) : void

Begin capturing content.

Requires that either the $_defaultDojotype property is set, or that you pass a value to the "dojoType" key of the $params argument.

Parameters
NameTypeDescription
$idstring
$paramsarray
$attribsarray
methodpubliccustomDijit(string $id = null, string $value = null, array $params = array(), array $attribs = array()) : string | \Zend_Dojo_View_Helper_CustomDijit

Render a custom dijit

Requires that either the $_defaultDojotype property is set, or that you pass a value to the "dojoType" key of the $params argument.

Parameters
NameTypeDescription
$idstring
$valuestring
$paramsarray
$attribsarray
Returns
TypeDescription
string | \Zend_Dojo_View_Helper_CustomDijit
methodpublicgetClosingBracket() : string
Returns
TypeDescription
string
methodpublicgetRootNode() : string
Returns
TypeDescription
string
methodpublicsetRootNode(string $value) : \Zend_Dojo_View_Helper_Dijit
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Dojo_View_Helper_Dijit
methodpublicsetView(\Zend_View_Interface $view) : \Zend_Dojo_View_Helper_Dijit

Set view and enable dojo

Parameters
NameTypeDescription
$view\Zend_View_Interface
Returns
TypeDescription
\Zend_Dojo_View_Helper_Dijit
Documentation was generated by phpDocumentor 2.0.0a12.