Class Zend_Dojo_View_Helper_Dojo_Container

Description

Container for Dojo View Helper

  • copyright: Copyright (C) 2008 - Present, Zend Technologies, Inc.
  • license: New

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


	
			
Variable Summary
Method Summary
 string dijitsToJson ()
 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 getStylesheets ()
 bool hasDijit (string $id)
 bool isEnabled ()
 Zend_Dojo_View_Helper_Dojo_Container setDjConfig ( $config, string $option, mixed $value)
 Zend_Dojo_View_Helper_Dojo_Container setDjConfigOption (string $option, mixed $value)
 void setView ( $view)
 bool useCdn ()
 bool useLocalPath ()
 string _renderDjConfig ()
 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.2.0' (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)

Register the Dojo stylesheet?

  • access: protected
array $_stylesheetModules = array() (line 154)

Style sheet modules to load

  • access: protected
array $_stylesheets = array() (line 160)

Local stylesheets

  • access: protected
Methods
addDijit (line 641)

Add a programmatic dijit

  • access: public
Zend_Dojo_View_Helper_Dojo_Container addDijit (string $id,  $params)
  • string $id
  • array $params
addDijits (line 677)

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 805)

Add arbitrary javascript to execute in dojo JS container

  • access: public
Zend_Dojo_View_Helper_Dojo_Container addJavascript (string $js)
  • string $js
addLayer (line 276)

Add layer (custom build) path

  • access: public
Zend_Dojo_View_Helper_Dojo_Container addLayer (string $path)
  • string $path
addOnLoad (line 571)

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 523)

Add a stylesheet

  • access: public
Zend_Dojo_View_Helper_Dojo_Container addStylesheet (string $path)
  • string $path
addStylesheetModule (line 494)

Add a stylesheet by module name

  • access: public
Zend_Dojo_View_Helper_Dojo_Container addStylesheetModule (string $module)
  • string $module
clearDijits (line 756)

Clear all dijits

  • access: public
clearJavascript (line 835)

Clear arbitrary javascript stack

  • access: public
clearLayers (line 317)

Clear all registered layers

  • access: public
dijitsToJson (line 767)

Render dijits as JSON structure

  • access: public
string dijitsToJson ()
disable (line 189)

Disable dojo

  • access: public
enable (line 178)

Enable dojo

  • access: public
getCdnBase (line 340)

Return CDN base URL

  • access: public
string getCdnBase ()
getCdnDojoPath (line 387)

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

  • access: public
string getCdnDojoPath ()
getCdnVersion (line 365)

Get CDN version

  • access: public
string getCdnVersion ()
getDijit (line 716)

Retrieve a dijit by id

  • access: public
array|null getDijit (string $id)
  • string $id
getDijits (line 731)

Retrieve all dijits

Returns dijits as an array of assoc arrays

  • access: public
array getDijits ()
getDjConfig (line 467)

Retrieve dojo configuration values

  • access: public
array getDjConfig ()
getDjConfigOption (line 479)

Get dojo configuration value

  • access: public
mixed getDjConfigOption (string $option, [mixed $default = null])
  • string $option
  • mixed $default
getJavascript (line 825)

Return all registered javascript statements

  • access: public
array getJavascript ()
getLayers (line 290)

Get registered layers

  • access: public
array getLayers ()
getLocalPath (line 420)

Get local path to dojo

  • access: public
string getLocalPath ()
getModulePaths (line 265)

List registered module paths

  • access: public
array getModulePaths ()
getModules (line 239)

Retrieve list of modules to require

  • access: public
array getModules ()
getOnLoadActions (line 598)

Retrieve all registered onLoad actions

  • access: public
array getOnLoadActions ()
getStylesheetModules (line 512)

Get all stylesheet modules currently registered

  • access: public
array getStylesheetModules ()
getStylesheets (line 556)

Retrieve registered stylesheets

  • access: public
array getStylesheets ()
hasDijit (line 705)

Is the given programmatic dijit already registered?

  • access: public
bool hasDijit (string $id)
  • string $id
isEnabled (line 200)

Is dojo enabled?

  • access: public
bool isEnabled ()
javascriptCaptureEnd (line 863)

Finish capturing arbitrary javascript to include in dojo script

  • access: public
true javascriptCaptureEnd ()
javascriptCaptureStart (line 846)

Capture arbitrary javascript to include in dojo script

  • access: public
void javascriptCaptureStart ()
onLoadCaptureEnd (line 625)

Stop capturing routines to run onLoad

  • access: public
bool onLoadCaptureEnd ()
onLoadCaptureStart (line 608)

Start capturing routines to run onLoad

  • access: public
bool onLoadCaptureStart ()
prependOnLoad (line 585)

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 778)

Create dijit loader functionality

  • access: public
void registerDijitLoader ()
registerDojoStylesheet (line 541)

Register the dojo.css stylesheet?

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 250)

Register a module path

  • access: public
Zend_Dojo_View_Helper_Dojo_Container registerModulePath ( $module, string $path)
  • string $path
  • $module
removeDijit (line 742)

Remove a programmatic dijit if it exists

  • access: public
Zend_Dojo_View_Helper_Dojo_Container removeDijit (string $id)
  • string $id
removeLayer (line 301)

Remove a registered layer

  • access: public
Zend_Dojo_View_Helper_Dojo_Container removeLayer (string $path)
  • string $path
requireModule (line 211)

Specify a module to require

  • access: public
Zend_Dojo_View_Helper_Dojo_Container requireModule (string $module)
  • string $module
setCdnBase (line 329)

Set CDN base path

  • access: public
Zend_Dojo_View_Helper_Dojo_Container setCdnBase (string $url)
  • string $url
setCdnDojoPath (line 376)

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 351)

Use CDN, using version specified

  • access: public
Zend_Dojo_View_Helper_Dojo_Container setCdnVersion ([string $version = null])
  • string $version
setDijit (line 663)

Set a programmatic dijit (overwrites)

  • access: public
Zend_Dojo_View_Helper_Dojo_Container setDijit (string $id,  $params)
  • string $id
  • array $params
setDijits (line 693)

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 442)

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 455)

Set Dojo configuration option

  • access: public
Zend_Dojo_View_Helper_Dojo_Container setDjConfigOption (string $option, mixed $value)
  • string $option
  • mixed $value
setLocalPath (line 408)

Set path to local dojo

  • access: public
Zend_Dojo_View_Helper_Dojo_Container setLocalPath (string $path)
  • string $path
setView (line 168)

Set view object

  • access: public
void setView ( $view)
  • Zend_Dojo_View_Interface $view
useCdn (line 397)

Are we using the CDN?

  • access: public
bool useCdn ()
useLocalPath (line 430)

Are we using a local path?

  • access: public
bool useLocalPath ()
_getLocalRelativePath (line 908)

Retrieve local path to dojo resources for building relative paths

  • access: protected
string _getLocalRelativePath ()
_renderDjConfig (line 968)

Render DjConfig values

  • access: protected
string _renderDjConfig ()
_renderDojoScriptTag (line 994)

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 1036)

Render dojo module paths and requires

  • access: protected
string _renderExtras ()
_renderLayers (line 1013)

Render layers (custom builds) as script tags

  • access: protected
string _renderLayers ()
_renderStylesheets (line 923)

Render dojo stylesheets

  • access: protected
string _renderStylesheets ()
__toString (line 877)

String representation of dojo environment

  • access: public
string __toString ()

Documentation generated on Fri, 08 Jan 2010 16:09:02 -0500 by phpDocumentor 1.4.3