API Documentation

Dojo/View/Helper/CustomDijit.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Dojo  
subpackage
View  
version
$Id: CustomDijit.php 23953 2011-05-03 05:47:39Z ralph $  

\Zend_Dojo_View_Helper_CustomDijit

Arbitrary dijit support

Extends from
\Zend_Dojo_View_Helper_DijitContainer
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Dojo  
subpackage
View  
uses
\Zend_Dojo_View_Helper_DijitContainer  

Properties

Propertyprotectedstring  $_defaultDojoType= ''

Default dojoType; set the value when extending

Details
Type
string

Methods

methodprotected_castBoolToString( mixed $item, string $key ) : void

Cast a boolean to a string value

Inherited from: \Zend_Dojo_View_Helper_Dijit::_castBoolToString()
Parameters
Name Type Description
$item mixed
$key string
methodprotected_createDijit( string $dijit, string $id, array $params ) : void

Create a dijit programmatically

Inherited from: \Zend_Dojo_View_Helper_Dijit::_createDijit()
Parameters
Name Type Description
$dijit string
$id string
$params array
methodpublic_createFormElement( string $id, string $value, array $params, array $attribs, string|null $dijit = null ) : string

Create HTML representation of a dijit form element

Inherited from: \Zend_Dojo_View_Helper_Dijit::_createFormElement()
Parameters
Name Type Description
$id string
$value string
$params array
$attribs array
$dijit string|null
Returns
Type Description
string
methodprotected_createGetParentFormFunction( ) : void

Create JS function for retrieving parent form

Inherited from: \Zend_Dojo_View_Helper_Dijit::_createGetParentFormFunction()
methodprotected_createLayoutContainer( int $id, string $content, array $params, array $attribs, string|null $dijit = null ) : string

Create a layout container

Inherited from: \Zend_Dojo_View_Helper_Dijit::_createLayoutContainer()
Parameters
Name Type Description
$id int
$content string
$params array
$attribs array
$dijit string|null
Returns
Type Description
string
methodprotected_htmlAttribs( array $attribs ) : string

Converts an associative array to a string of tag attributes.

Inherited from: \Zend_View_Helper_HtmlElement::_htmlAttribs()
Parameters
Name Type Description
$attribs array

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

Returns
Type Description
string The XHTML for the attributes.
Details
access
public  
methodprotected_isStrictDoctype( ) : boolean

Is doctype strict?

Inherited from: \Zend_View_Helper_HtmlElement::_isStrictDoctype()
Returns
Type Description
boolean
methodprotected_isXhtml( ) : boolean

Is doctype XHTML?

Inherited from: \Zend_View_Helper_HtmlElement::_isXhtml()
Returns
Type Description
boolean
methodprotected_normalizeId( string $value ) : string

Normalize an ID

Inherited from: \Zend_View_Helper_HtmlElement::_normalizeId()
Parameters
Name Type Description
$value string
Returns
Type Description
string
methodprotected_prepareDijit( array $attribs, array $params, string $type, string $dijit = null ) : array

Merge attributes and parameters

Inherited from: \Zend_Dojo_View_Helper_Dijit::_prepareDijit()

Also sets up requires

Parameters
Name Type Description
$attribs array
$params array
$type string
$dijit string

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

Returns
Type Description
array
methodprotected_renderHiddenElement( string $id, string|int|float $value ) : string

Render a hidden element to hold a value

Inherited from: \Zend_Dojo_View_Helper_Dijit::_renderHiddenElement()
Parameters
Name Type Description
$id string
$value string|int|float
Returns
Type Description
string
methodprotected_useDeclarative( ) : bool

Whether or not to use declarative dijit creation

Inherited from: \Zend_Dojo_View_Helper_Dijit::_useDeclarative()
Returns
Type Description
bool
methodprotected_useProgrammatic( ) : bool

Whether or not to use programmatic dijit creation

Inherited from: \Zend_Dojo_View_Helper_Dijit::_useProgrammatic()
Returns
Type Description
bool
methodprotected_useProgrammaticNoScript( ) : bool

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

Inherited from: \Zend_Dojo_View_Helper_Dijit::_useProgrammaticNoScript()
Returns
Type Description
bool
methodpubliccaptureEnd( string $id ) : string

Finish capturing content for layout container

Inherited from: \Zend_Dojo_View_Helper_DijitContainer::captureEnd()
Parameters
Name Type Description
$id string
Returns
Type Description
string
methodpubliccaptureStart( string $id, array $params = array, array $attribs = array ) : void

Begin capturing content.

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

Parameters
Name Type Description
$id string
$params array
$attribs array
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 {@link $_defaultDojotype} property is set, or that you pass a value to the "dojoType" key of the $params argument.

Parameters
Name Type Description
$id string
$value string
$params array
$attribs array
Returns
Type Description
string\Zend_Dojo_View_Helper_CustomDijit
methodpublicdirect( ) : void

Strategy pattern: currently unutilized

Inherited from: \Zend_View_Helper_Abstract::direct()
methodpublicgetClosingBracket( ) : string

Get the tag closing bracket

Inherited from: \Zend_View_Helper_HtmlElement::getClosingBracket()
Returns
Type Description
string
methodpublicgetRootNode( ) : string

Get root node type

Inherited from: \Zend_Dojo_View_Helper_Dijit::getRootNode()
Returns
Type Description
string
methodpublicsetRootNode( string $value ) : \Zend_Dojo_View_Helper_Dijit

Set root node type

Inherited from: \Zend_Dojo_View_Helper_Dijit::setRootNode()
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Dojo_View_Helper_Dijit
methodpublicsetView( \Zend_View_Interface $view ) : \Zend_Dojo_View_Helper_Dijit

Set view

Inherited from: \Zend_Dojo_View_Helper_Dijit::setView()

Set view and enable dojo

Parameters
Name Type Description
$view \Zend_View_Interface
Returns
Type Description
\Zend_Dojo_View_Helper_Dijit
Documentation was generated by DocBlox 0.13.3.