Container for Dojo View Helper

package Zend_Dojo
subpackage View
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

String representation of dojo environment

__toString() : string

Returns

string

Add an onLoad action related to ZF dijit creation

_addZendLoad(string $callback) : \Zend_Dojo_View_Helper_Dojo_Container

This method is public, but prefixed with an underscore to indicate that it should not normally be called by userland code. It is pertinent to ensuring that the correct order of operations occurs during dijit creation.

Parameters

$callback

string

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Retrieve all ZF dijit callbacks

_getZendLoadActions() : array

Returns

array

Add a programmatic dijit

addDijit(string $id, array $params) : \Zend_Dojo_View_Helper_Dojo_Container

Parameters

$id

string

$params

array

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Add multiple dijits at once

addDijits(array $dijits) : \Zend_Dojo_View_Helper_Dojo_Container

Expects an array of id => array $params pairs

Parameters

$dijits

array

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Add arbitrary javascript to execute in dojo JS container

addJavascript(string $js) : \Zend_Dojo_View_Helper_Dojo_Container

Parameters

$js

string

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Add layer (custom build) path

addLayer(string $path) : \Zend_Dojo_View_Helper_Dojo_Container

Parameters

$path

string

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Add a script to execute onLoad

addOnLoad(string $callback) : \Zend_Dojo_View_Helper_Dojo_Container

dojo.addOnLoad accepts:

  • function name
  • lambda

Parameters

$callback

string

Lambda

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Add a stylesheet

addStylesheet(string $path) : \Zend_Dojo_View_Helper_Dojo_Container

Parameters

$path

string

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Add a stylesheet by module name

addStylesheetModule(string $module) : \Zend_Dojo_View_Helper_Dojo_Container

Parameters

$module

string

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Clear all dijits

clearDijits() : \Zend_Dojo_View_Helper_Dojo_Container

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Clear arbitrary javascript stack

clearJavascript() : \Zend_Dojo_View_Helper_Dojo_Container

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Clear all registered layers

clearLayers() : \Zend_Dojo_View_Helper_Dojo_Container

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Render dijits as JSON structure

dijitsToJson() : string

Returns

string

Disable dojo

disable() : \Zend_Dojo_View_Helper_Dojo_Container

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Enable dojo

enable() : \Zend_Dojo_View_Helper_Dojo_Container

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Return CDN base URL

getCdnBase() : string

Returns

string

Get CDN path to dojo (relative to CDN base + version)

getCdnDojoPath() : string

Returns

string

Get CDN version

getCdnVersion() : string

Returns

string

Retrieve a dijit by id

getDijit(string $id) : array | null

Parameters

$id

string

Returns

arraynull

Retrieve all dijits

getDijits() : array

Returns dijits as an array of assoc arrays

Returns

array

Retrieve dojo configuration values

getDjConfig() : array

Returns

array

Get dojo configuration value

getDjConfigOption(string $option, mixed $default = null) : mixed

Parameters

$option

string

$default

mixed

Returns

mixed

Return all registered javascript statements

getJavascript() : array

Returns

array

Get registered layers

getLayers() : array

Returns

array

Get local path to dojo

getLocalPath() : string

Returns

string

List registered module paths

getModulePaths() : array

Returns

array

Retrieve list of modules to require

getModules() : array

Returns

array

Retrieve all registered onLoad actions

getOnLoadActions() : array

Returns

array

Get all stylesheet modules currently registered

getStylesheetModules() : array

Returns

array

Retrieve registered stylesheets

getStylesheets() : array

Returns

array

Is the given programmatic dijit already registered?

hasDijit(string $id) : boolean

Parameters

$id

string

Returns

boolean

Is dojo enabled?

isEnabled() : boolean

Returns

boolean

Finish capturing arbitrary javascript to include in dojo script

javascriptCaptureEnd() : true

Returns

true

Capture arbitrary javascript to include in dojo script

javascriptCaptureStart() : void

Stop capturing routines to run onLoad

onLoadCaptureEnd() : boolean

Returns

boolean

Start capturing routines to run onLoad

onLoadCaptureStart() : boolean

Returns

boolean

Prepend an onLoad event to the list of onLoad actions

prependOnLoad(string $callback) : \Zend_Dojo_View_Helper_Dojo_Container

Parameters

$callback

string

Lambda

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Create dijit loader functionality

registerDijitLoader() : void

Register the dojo.css stylesheet?

registerDojoStylesheet(null|boolean $flag = null) : \Zend_Dojo_View_Helper_Dojo_Container | boolean

With no arguments, returns the status of the flag; with arguments, sets the flag and returns the object.

Parameters

$flag

nullboolean

Returns

\Zend_Dojo_View_Helper_Dojo_Containerboolean

Register a module path

registerModulePath(string $module, string $path) : \Zend_Dojo_View_Helper_Dojo_Container

Parameters

$module

string

The module to register a path for

$path

string

The path to register for the module

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Remove a programmatic dijit if it exists

removeDijit(string $id) : \Zend_Dojo_View_Helper_Dojo_Container

Parameters

$id

string

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Remove a registered layer

removeLayer(string $path) : \Zend_Dojo_View_Helper_Dojo_Container

Parameters

$path

string

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Specify one or multiple modules to require

requireModule(string|array $modules) : \Zend_Dojo_View_Helper_Dojo_Container

Parameters

$modules

stringarray

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Set CDN base path

setCdnBase(string $url) : \Zend_Dojo_View_Helper_Dojo_Container

Parameters

$url

string

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Set CDN path to dojo (relative to CDN base + version)

setCdnDojoPath(string $path) : \Zend_Dojo_View_Helper_Dojo_Container

Parameters

$path

string

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Use CDN, using version specified

setCdnVersion(string $version = null) : \Zend_Dojo_View_Helper_Dojo_Container

Parameters

$version

string

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Set a programmatic dijit (overwrites)

setDijit(string $id, array $params) : \Zend_Dojo_View_Helper_Dojo_Container

Parameters

$id

string

$params

array

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Set multiple dijits at once (overwrites)

setDijits(array $dijits) : \Zend_Dojo_View_Helper_Dojo_Container

Expects an array of id => array $params pairs

Parameters

$dijits

array

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Set Dojo configuration

setDjConfig(array $config) : \Zend_Dojo_View_Helper_Dojo_Container

Parameters

$config

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Set Dojo configuration option

setDjConfigOption(string $option, mixed $value) : \Zend_Dojo_View_Helper_Dojo_Container

Parameters

$option

string

$value

mixed

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Set path to local dojo

setLocalPath(string $path) : \Zend_Dojo_View_Helper_Dojo_Container

Parameters

$path

string

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Add options for the Dojo Container to use

setOptions($options) : \Zend_Dojo_View_Helper_Dojo_Container

Parameters

$options

Returns

\Zend_Dojo_View_Helper_Dojo_Container

Set view object

setView(\Zend_Dojo_View_Interface $view) : void

Parameters

$view

\Zend_Dojo_View_Interface

Are we using the CDN?

useCdn() : boolean

Returns

boolean

Are we using a local path?

useLocalPath() : boolean

Returns

boolean

Retrieve local path to dojo resources for building relative paths

_getLocalRelativePath() : string

Returns

string

Render DjConfig values

_renderDjConfig() : string

Returns

string

Render dojo script tag

_renderDojoScriptTag() : string

Renders Dojo script tag by utilizing either local path provided or the CDN. If any djConfig values were set, they will be serialized and passed with that attribute.

Returns

string

Render dojo module paths and requires

_renderExtras() : string

Returns

string

Render layers (custom builds) as script tags

_renderLayers() : string

Returns

string

Render dojo stylesheets

_renderStylesheets() : string

Returns

string

 Properties

 

$view

$view : \Zend_View_Interface

Default

 

addOnLoad capture lock

$_captureLock : boolean

Default

false
 

addOnLoad object on which to apply lambda

$_captureObj : string

Default

 

Base CDN url to utilize

$_cdnBase : string

Default

\Zend_Dojo::CDN_BASE_GOOGLE
 

Path segment following version string of CDN path

$_cdnDojoPath : string

Default

\Zend_Dojo::CDN_DOJO_PATH_GOOGLE
 

Dojo version to use from CDN

$_cdnVersion : string

Default

'1.5.0'
 

Has the dijit loader been registered?

$_dijitLoaderRegistered : boolean

Default

false
 

Registered programmatic dijits

$_dijits : array

Default

array()
 

Dojo configuration

$_djConfig : array

Default

array()
 

Whether or not dojo is enabled

$_enabled : boolean

Default

false
 

Are we rendering as XHTML?

$_isXhtml : boolean

Default

false
 

Arbitrary javascript to include in dojo script

$_javascriptStatements : array

Default

array()
 

Dojo layers (custom builds) to use

$_layers : array

Default

array()
 

Relative path to dojo

$_localPath : string

Default

null
 

Root of dojo where all dojo files are installed

$_localRelativePath : string

Default

null
 

Registered module paths

$_modulePaths : array

Default

array()
 

Modules to require

$_modules : array

Default

array()
 

Actions to perform on window load

$_onLoadActions : array

Default

array()
 

Register the Dojo stylesheet?

$_registerDojoStylesheet : boolean

Default

false
 

Style sheet modules to load

$_stylesheetModules : array

Default

array()
 

Local stylesheets

$_stylesheets : array

Default

array()
 

Array of onLoad events specific to Zend_Dojo integration operations

$_zendLoadActions : array

Default

array()