Docs For Class Zend_Dojo_View_Helper_Dojo

Zend_Dojo_View_Helper_Dojo_Container

Description

Container for Dojo View Helper

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /Dojo/View/Helper/Dojo/Container.php (line 35)

Variable Summary

Zend_View_Interface $view

bool $_captureLock

string $_captureObj

string $_cdnBase

string $_cdnDojoPath

string $_cdnVersion

bool $_dijitLoaderRegistered

array $_dijits

array $_djConfig

bool $_enabled

bool $_isXhtml

array $_javascriptStatements

array $_layers

string $_localPath

string $_localRelativePath

array $_modulePaths

array $_modules

array $_onLoadActions

bool $_registerDojoStylesheet

array $_stylesheetModules

array $_stylesheets

array $_zendLoadActions

Method Summary

Zend_Dojo_View_Helper_Dojo_Container addDijit (string $id, $params)

Zend_Dojo_View_Helper_Dojo_Container addDijits ( $dijits)

Zend_Dojo_View_Helper_Dojo_Container addJavascript (string $js)

Zend_Dojo_View_Helper_Dojo_Container addLayer (string $path)

Zend_Dojo_View_Helper_Dojo_Container addOnLoad (string $callback)

Zend_Dojo_View_Helper_Dojo_Container addStylesheet (string $path)

Zend_Dojo_View_Helper_Dojo_Container addStylesheetModule (string $module)

Zend_Dojo_View_Helper_Dojo_Container clearDijits ()

Zend_Dojo_View_Helper_Dojo_Container clearJavascript ()

Zend_Dojo_View_Helper_Dojo_Container clearLayers ()

string dijitsToJson ()

Zend_Dojo_View_Helper_Dojo_Container disable ()

Zend_Dojo_View_Helper_Dojo_Container enable ()

string getCdnBase ()

string getCdnDojoPath ()

string getCdnVersion ()

array|null getDijit (string $id)

array getDijits ()

array getDjConfig ()

mixed getDjConfigOption (string $option, [mixed $default = null])

array getJavascript ()

array getLayers ()

string getLocalPath ()

array getModulePaths ()

array getModules ()

array getOnLoadActions ()

array getStylesheetModules ()

array getStylesheets ()

bool hasDijit (string $id)

bool isEnabled ()

true javascriptCaptureEnd ()

void javascriptCaptureStart ()

bool onLoadCaptureEnd ()

bool onLoadCaptureStart ()

Zend_Dojo_View_Helper_Dojo_Container prependOnLoad (string $callback)

void registerDijitLoader ()

Zend_Dojo_View_Helper_Dojo_Container|bool registerDojoStylesheet ([null|bool $flag = null])

Zend_Dojo_View_Helper_Dojo_Container registerModulePath (string $module, string $path)

Zend_Dojo_View_Helper_Dojo_Container removeDijit (string $id)

Zend_Dojo_View_Helper_Dojo_Container removeLayer (string $path)

Zend_Dojo_View_Helper_Dojo_Container requireModule (string|array $modules)

Zend_Dojo_View_Helper_Dojo_Container setCdnBase (string $url)

Zend_Dojo_View_Helper_Dojo_Container setCdnDojoPath (string $path)

Zend_Dojo_View_Helper_Dojo_Container setCdnVersion ([string $version = null])

Zend_Dojo_View_Helper_Dojo_Container setDijit (string $id, $params)

Zend_Dojo_View_Helper_Dojo_Container setDijits ( $dijits)

Zend_Dojo_View_Helper_Dojo_Container setDjConfig ( $config, string $option, mixed $value)

Zend_Dojo_View_Helper_Dojo_Container setDjConfigOption (string $option, mixed $value)

Zend_Dojo_View_Helper_Dojo_Container setLocalPath (string $path)

Zend_Dojo_View_Helper_Dojo_Container setOptions (array|Zend_Config $options)

void setView ( $view)

bool useCdn ()

bool useLocalPath ()

Zend_Dojo_View_Helper_Dojo_Container _addZendLoad (string $callback)

string _getLocalRelativePath ()

array _getZendLoadActions ()

string _renderDjConfig ()

string _renderDojoScriptTag ()

string _renderExtras ()

string _renderLayers ()

string _renderStylesheets ()

string __toString ()

Variables

Zend_View_Interface $view (line 40)

access: public

bool $_captureLock = false (line 46)

addOnLoad capture lock

access: protected

string $_captureObj (line 52)

addOnLoad object on which to apply lambda

access: protected

string $_cdnBase = Zend_Dojo::CDN_BASE_GOOGLE (line 58)

Base CDN url to utilize

access: protected

string $_cdnDojoPath = Zend_Dojo::CDN_DOJO_PATH_GOOGLE (line 64)

Path segment following version string of CDN path

access: protected

string $_cdnVersion = '1.4.1' (line 70)

Dojo version to use from CDN

access: protected

bool $_dijitLoaderRegistered = false (line 76)

Has the dijit loader been registered?

access: protected

array $_dijits = array() (line 82)

Registered programmatic dijits

access: protected

array $_djConfig = array() (line 88)

Dojo configuration

access: protected

bool $_enabled = false (line 94)

Whether or not dojo is enabled

access: protected

bool $_isXhtml = false (line 100)

Are we rendering as XHTML?

access: protected

array $_javascriptStatements = array() (line 106)

Arbitrary javascript to include in dojo script

access: protected

array $_layers = array() (line 112)

Dojo layers (custom builds) to use

access: protected

string $_localPath = null (line 118)

Relative path to dojo

access: protected

string $_localRelativePath = null (line 124)

Root of dojo where all dojo files are installed

access: protected

array $_modulePaths = array() (line 136)

Registered module paths

access: protected

array $_modules = array() (line 130)

Modules to require

access: protected

array $_onLoadActions = array() (line 142)

Actions to perform on window load

access: protected

bool $_registerDojoStylesheet = false (line 148)

access: protected

array $_stylesheetModules = array() (line 154)

Style sheet modules to load

access: protected

array $_stylesheets = array() (line 160)

Local stylesheets

access: protected

array $_zendLoadActions = array() (line 166)

Array of onLoad events specific to Zend_Dojo integration operations

access: protected

Methods

addDijit (line 713)

Add a programmatic dijit

access: public

Zend_Dojo_View_Helper_Dojo_Container addDijit (string $id, $params)

string $id
array $params

addDijits (line 749)

Add multiple dijits at once

Expects an array of id => array $params pairs

access: public

Zend_Dojo_View_Helper_Dojo_Container addDijits ( $dijits)

array $dijits

addJavascript (line 877)

Add arbitrary javascript to execute in dojo JS container

access: public

Zend_Dojo_View_Helper_Dojo_Container addJavascript (string $js)

string $js

addLayer (line 348)

Add layer (custom build) path

access: public

Zend_Dojo_View_Helper_Dojo_Container addLayer (string $path)

string $path

addOnLoad (line 643)

Add a script to execute onLoad

dojo.addOnLoad accepts:

function name
lambda

access: public

Zend_Dojo_View_Helper_Dojo_Container addOnLoad (string $callback)

string $callback: Lambda

addStylesheet (line 595)

Add a stylesheet

access: public

Zend_Dojo_View_Helper_Dojo_Container addStylesheet (string $path)

string $path

addStylesheetModule (line 567)

Add a stylesheet by module name

access: public

Zend_Dojo_View_Helper_Dojo_Container addStylesheetModule (string $module)

string $module

clearDijits (line 828)

Clear all dijits

access: public

Zend_Dojo_View_Helper_Dojo_Container clearDijits ()

clearJavascript (line 907)

Clear arbitrary javascript stack

access: public

Zend_Dojo_View_Helper_Dojo_Container clearJavascript ()

clearLayers (line 390)

Clear all registered layers

access: public

Zend_Dojo_View_Helper_Dojo_Container clearLayers ()

dijitsToJson (line 839)

Render dijits as JSON structure

access: public

string dijitsToJson ()

disable (line 195)

Disable dojo

access: public

Zend_Dojo_View_Helper_Dojo_Container disable ()

enable (line 184)

Enable dojo

access: public

Zend_Dojo_View_Helper_Dojo_Container enable ()

getCdnBase (line 413)

Return CDN base URL

access: public

string getCdnBase ()

getCdnDojoPath (line 460)

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

access: public

string getCdnDojoPath ()

getCdnVersion (line 438)

Get CDN version

access: public

string getCdnVersion ()

getDijit (line 788)

Retrieve a dijit by id

access: public

array|null getDijit (string $id)

string $id

getDijits (line 803)

Retrieve all dijits

Returns dijits as an array of assoc arrays

access: public

array getDijits ()

getDjConfig (line 540)

Retrieve dojo configuration values

access: public

array getDjConfig ()

getDjConfigOption (line 552)

Get dojo configuration value

access: public

mixed getDjConfigOption (string $option, [mixed $default = null])

string $option
mixed $default

getJavascript (line 897)

Return all registered javascript statements

access: public

array getJavascript ()

getLayers (line 363)

Get registered layers

access: public

array getLayers ()

getLocalPath (line 493)

Get local path to dojo

access: public

string getLocalPath ()

getModulePaths (line 337)

List registered module paths

access: public

array getModulePaths ()

getModules (line 310)

Retrieve list of modules to require

access: public

array getModules ()

getOnLoadActions (line 670)

Retrieve all registered onLoad actions

access: public

array getOnLoadActions ()

getStylesheetModules (line 584)

Get all stylesheet modules currently registered

access: public

array getStylesheetModules ()

getStylesheets (line 628)

Retrieve registered stylesheets

access: public

array getStylesheets ()

hasDijit (line 777)

Is the given programmatic dijit already registered?

access: public

bool hasDijit (string $id)

string $id

isEnabled (line 206)

Is dojo enabled?

access: public

bool isEnabled ()

javascriptCaptureEnd (line 935)

Finish capturing arbitrary javascript to include in dojo script

access: public

true javascriptCaptureEnd ()

javascriptCaptureStart (line 918)

Capture arbitrary javascript to include in dojo script

access: public

void javascriptCaptureStart ()

onLoadCaptureEnd (line 697)

Stop capturing routines to run onLoad

access: public

bool onLoadCaptureEnd ()

onLoadCaptureStart (line 680)

Start capturing routines to run onLoad

access: public

bool onLoadCaptureStart ()

prependOnLoad (line 657)

Prepend an onLoad event to the list of onLoad actions

access: public

Zend_Dojo_View_Helper_Dojo_Container prependOnLoad (string $callback)

string $callback: Lambda

registerDijitLoader (line 850)

Create dijit loader functionality

access: public

void registerDijitLoader ()

registerDojoStylesheet (line 613)

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

access: public

Zend_Dojo_View_Helper_Dojo_Container|bool registerDojoStylesheet ([null|bool $flag = null])

null|bool $flag

registerModulePath (line 322)

access: public

Zend_Dojo_View_Helper_Dojo_Container registerModulePath (string $module, string $path)

string $module: The module to register a path for
string $path: The path to register for the module

removeDijit (line 814)

Remove a programmatic dijit if it exists

access: public

Zend_Dojo_View_Helper_Dojo_Container removeDijit (string $id)

string $id

removeLayer (line 374)

Remove a registered layer

access: public

Zend_Dojo_View_Helper_Dojo_Container removeLayer (string $path)

string $path

requireModule (line 282)

Specify one or multiple modules to require

access: public

Zend_Dojo_View_Helper_Dojo_Container requireModule (string|array $modules)

string|array $modules

setCdnBase (line 402)

Set CDN base path

access: public

Zend_Dojo_View_Helper_Dojo_Container setCdnBase (string $url)

string $url

setCdnDojoPath (line 449)

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

access: public

Zend_Dojo_View_Helper_Dojo_Container setCdnDojoPath (string $path)

string $path

setCdnVersion (line 424)

Use CDN, using version specified

access: public

Zend_Dojo_View_Helper_Dojo_Container setCdnVersion ([string $version = null])

string $version

setDijit (line 735)

Set a programmatic dijit (overwrites)

access: public

Zend_Dojo_View_Helper_Dojo_Container setDijit (string $id, $params)

string $id
array $params

setDijits (line 765)

Set multiple dijits at once (overwrites)

Expects an array of id => array $params pairs

access: public

Zend_Dojo_View_Helper_Dojo_Container setDijits ( $dijits)

array $dijits

setDjConfig (line 515)

Set Dojo configuration

access: public

Zend_Dojo_View_Helper_Dojo_Container setDjConfig ( $config, string $option, mixed $value)

string $option
mixed $value
array $config

setDjConfigOption (line 528)

Set Dojo configuration option

access: public

Zend_Dojo_View_Helper_Dojo_Container setDjConfigOption (string $option, mixed $value)

string $option
mixed $value

setLocalPath (line 481)

Set path to local dojo

access: public

Zend_Dojo_View_Helper_Dojo_Container setLocalPath (string $path)

string $path

setOptions (line 217)

Add options for the Dojo Container to use

access: public

Zend_Dojo_View_Helper_Dojo_Container setOptions (array|Zend_Config $options)

array|Zend_Config $options: Array or Zend_Config object with options to use

setView (line 174)

Set view object

access: public

void setView ( $view)

Zend_Dojo_View_Interface $view

useCdn (line 470)

Are we using the CDN?

access: public

bool useCdn ()

useLocalPath (line 503)

Are we using a local path?

access: public

bool useLocalPath ()

_addZendLoad (line 1182)

Add an onLoad action related to ZF dijit creation

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.

access: public

Zend_Dojo_View_Helper_Dojo_Container _addZendLoad (string $callback)

string $callback

_getLocalRelativePath (line 980)

Retrieve local path to dojo resources for building relative paths

access: protected

string _getLocalRelativePath ()

_getZendLoadActions (line 1195)

Retrieve all ZF dijit callbacks

access: public

array _getZendLoadActions ()

_renderDjConfig (line 1040)

Render DjConfig values

access: protected

string _renderDjConfig ()

_renderDojoScriptTag (line 1066)

Render dojo script tag

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.

access: protected

string _renderDojoScriptTag ()

_renderExtras (line 1115)

Render dojo module paths and requires

access: protected

string _renderExtras ()

_renderLayers (line 1085)

Render layers (custom builds) as script tags

access: protected

string _renderLayers ()

_renderStylesheets (line 995)

Render dojo stylesheets

access: protected

string _renderStylesheets ()

__toString (line 949)

String representation of dojo environment

access: public

string __toString ()

Documentation generated on Mon, 21 Jun 2010 15:13:47 -0400 by phpDocumentor 1.4.3