API Documentation

Dojo/View/Helper/Dojo/Container.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Dojo
subpackage
View
version
$Id: Container.php 21705 2010-03-31 17:38:19Z matthew $
Classes
Zend_Dojo_View_Helper_Dojo_Container

Description

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.

Zend_Dojo_View_Helper_Dojo_Container
jump to top

copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Dojo
subpackage
View
Properties
$view
$_captureLock
$_captureObj
$_cdnBase
$_cdnDojoPath
$_cdnVersion
$_dijitLoaderRegistered
$_dijits
$_djConfig
$_enabled
$_isXhtml
$_javascriptStatements
$_layers
$_localPath
$_localRelativePath
$_modules
$_modulePaths
$_onLoadActions
$_registerDojoStylesheet
$_stylesheetModules
$_stylesheets
$_zendLoadActions
Methods
setView
enable
disable
isEnabled
setOptions
requireModule
getModules
registerModulePath
getModulePaths
addLayer
getLayers
removeLayer
clearLayers
setCdnBase
getCdnBase
setCdnVersion
getCdnVersion
setCdnDojoPath
getCdnDojoPath
useCdn
setLocalPath
getLocalPath
useLocalPath
setDjConfig
setDjConfigOption
getDjConfig
getDjConfigOption
addStylesheetModule
getStylesheetModules
addStylesheet
registerDojoStylesheet
getStylesheets
addOnLoad
prependOnLoad
getOnLoadActions
onLoadCaptureStart
onLoadCaptureEnd
addDijit
setDijit
addDijits
setDijits
hasDijit
getDijit
getDijits
removeDijit
clearDijits
dijitsToJson
registerDijitLoader
addJavascript
getJavascript
clearJavascript
javascriptCaptureStart
javascriptCaptureEnd
__toString
_getLocalRelativePath
_renderStylesheets
_renderDjConfig
_renderDojoScriptTag
_renderLayers
_renderExtras
_addZendLoad
_getZendLoadActions

Description

Container for Dojo View Helper

Properties

$_captureLock
jump to class

bool $_captureLock = 'false'

addOnLoad capture lock

Details

$_captureLock
bool
visibility
protected
default
false
final
false
static
false

$_captureObj
jump to class

string $_captureObj = ''

addOnLoad object on which to apply lambda

Details

$_captureObj
string
visibility
protected
default
final
false
static
false

$_cdnBase
jump to class

string $_cdnBase = 'Zend_Dojo'

Base CDN url to utilize

Details

$_cdnBase
string
visibility
protected
default
Zend_Dojo
final
false
static
false

$_cdnDojoPath
jump to class

string $_cdnDojoPath = 'Zend_Dojo'

Path segment following version string of CDN path

Details

$_cdnDojoPath
string
visibility
protected
default
Zend_Dojo
final
false
static
false

$_cdnVersion
jump to class

string $_cdnVersion = '1.4.1'

Dojo version to use from CDN

Details

$_cdnVersion
string
visibility
protected
default
1.4.1
final
false
static
false

$_dijitLoaderRegistered
jump to class

bool $_dijitLoaderRegistered = 'false'

Has the dijit loader been registered?

Details

$_dijitLoaderRegistered
bool
visibility
protected
default
false
final
false
static
false

$_dijits
jump to class

array $_dijits = 'array'

Registered programmatic dijits

Details

$_dijits
array
visibility
protected
default
array
final
false
static
false

$_djConfig
jump to class

array $_djConfig = 'array'

Dojo configuration

Details

$_djConfig
array
visibility
protected
default
array
final
false
static
false

$_enabled
jump to class

bool $_enabled = 'false'

Whether or not dojo is enabled

Details

$_enabled
bool
visibility
protected
default
false
final
false
static
false

$_isXhtml
jump to class

bool $_isXhtml = 'false'

Are we rendering as XHTML?

Details

$_isXhtml
bool
visibility
protected
default
false
final
false
static
false

$_javascriptStatements
jump to class

array $_javascriptStatements = 'array'

Arbitrary javascript to include in dojo script

Details

$_javascriptStatements
array
visibility
protected
default
array
final
false
static
false

$_layers
jump to class

array $_layers = 'array'

Dojo layers (custom builds) to use

Details

$_layers
array
visibility
protected
default
array
final
false
static
false

$_localPath
jump to class

string $_localPath = 'null'

Relative path to dojo

Details

$_localPath
string
visibility
protected
default
null
final
false
static
false

$_localRelativePath
jump to class

string $_localRelativePath = 'null'

Root of dojo where all dojo files are installed

Details

$_localRelativePath
string
visibility
protected
default
null
final
false
static
false

$_modulePaths
jump to class

array $_modulePaths = 'array'

Registered module paths

Details

$_modulePaths
array
visibility
protected
default
array
final
false
static
false

$_modules
jump to class

array $_modules = 'array'

Modules to require

Details

$_modules
array
visibility
protected
default
array
final
false
static
false

$_onLoadActions
jump to class

array $_onLoadActions = 'array'

Actions to perform on window load

Details

$_onLoadActions
array
visibility
protected
default
array
final
false
static
false

$_registerDojoStylesheet
jump to class

bool $_registerDojoStylesheet = 'false'

Register the Dojo stylesheet?

Details

$_registerDojoStylesheet
bool
visibility
protected
default
false
final
false
static
false

$_stylesheetModules
jump to class

array $_stylesheetModules = 'array'

Style sheet modules to load

Details

$_stylesheetModules
array
visibility
protected
default
array
final
false
static
false

$_stylesheets
jump to class

array $_stylesheets = 'array'

Local stylesheets

Details

$_stylesheets
array
visibility
protected
default
array
final
false
static
false

$_zendLoadActions
jump to class

array $_zendLoadActions = 'array'

Array of onLoad events specific to Zend_Dojo integration operations

Details

$_zendLoadActions
array
visibility
protected
default
array
final
false
static
false

$view
jump to class

Zend_View_Interface $view = ''

Details

$view
Zend_View_Interface
visibility
public
default
final
false
static
false

Methods

__toString
jump to class

__toString( ) : string

String representation of dojo environment

Output
string
Details
visibility
public
final
false
static
false

_addZendLoad
jump to class

_addZendLoad( string $callback ) : Zend_Dojo_View_Helper_Dojo_Container

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.

Arguments
$callback
string
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

_getLocalRelativePath
jump to class

_getLocalRelativePath( ) : string

Retrieve local path to dojo resources for building relative paths

Output
string
Details
visibility
protected
final
false
static
false

_getZendLoadActions
jump to class

_getZendLoadActions( ) : array

Retrieve all ZF dijit callbacks

Output
array
Details
visibility
public
final
false
static
false

_renderDjConfig
jump to class

_renderDjConfig( ) : string

Render DjConfig values

Output
string
Details
visibility
protected
final
false
static
false

_renderDojoScriptTag
jump to class

_renderDojoScriptTag( ) : string

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.

Output
string
Details
visibility
protected
final
false
static
false

_renderExtras
jump to class

_renderExtras( ) : string

Render dojo module paths and requires

Output
string
Details
visibility
protected
final
false
static
false

_renderLayers
jump to class

_renderLayers( ) : string

Render layers (custom builds) as script tags

Output
string
Details
visibility
protected
final
false
static
false

_renderStylesheets
jump to class

_renderStylesheets( ) : string

Render dojo stylesheets

Output
string
Details
visibility
protected
final
false
static
false

addDijit
jump to class

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

Add a programmatic dijit

Arguments
$id
string
$params
array
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

addDijits
jump to class

addDijits( array $dijits ) : Zend_Dojo_View_Helper_Dojo_Container

Add multiple dijits at once

Expects an array of id => array $params pairs

Arguments
$dijits
array
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

addJavascript
jump to class

addJavascript( string $js ) : Zend_Dojo_View_Helper_Dojo_Container

Add arbitrary javascript to execute in dojo JS container

Arguments
$js
string
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

addLayer
jump to class

addLayer( string $path ) : Zend_Dojo_View_Helper_Dojo_Container

Add layer (custom build) path

Arguments
$path
string
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

addOnLoad
jump to class

addOnLoad( string $callback ) : Zend_Dojo_View_Helper_Dojo_Container

Add a script to execute onLoad

dojo.addOnLoad accepts: - function name - lambda

Arguments
$callback
string
Lambda
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

addStylesheet
jump to class

addStylesheet( string $path ) : Zend_Dojo_View_Helper_Dojo_Container

Add a stylesheet

Arguments
$path
string
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

addStylesheetModule
jump to class

addStylesheetModule( string $module ) : Zend_Dojo_View_Helper_Dojo_Container

Add a stylesheet by module name

Arguments
$module
string
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

clearDijits
jump to class

clearDijits( ) : Zend_Dojo_View_Helper_Dojo_Container

Clear all dijits

Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

clearJavascript
jump to class

clearJavascript( ) : Zend_Dojo_View_Helper_Dojo_Container

Clear arbitrary javascript stack

Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

clearLayers
jump to class

clearLayers( ) : Zend_Dojo_View_Helper_Dojo_Container

Clear all registered layers

Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

dijitsToJson
jump to class

dijitsToJson( ) : string

Render dijits as JSON structure

Output
string
Details
visibility
public
final
false
static
false

disable
jump to class

disable( ) : Zend_Dojo_View_Helper_Dojo_Container

Disable dojo

Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

enable
jump to class

enable( ) : Zend_Dojo_View_Helper_Dojo_Container

Enable dojo

Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

getCdnBase
jump to class

getCdnBase( ) : string

Return CDN base URL

Output
string
Details
visibility
public
final
false
static
false

getCdnDojoPath
jump to class

getCdnDojoPath( ) : string

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

Output
string
Details
visibility
public
final
false
static
false

getCdnVersion
jump to class

getCdnVersion( ) : string

Get CDN version

Output
string
Details
visibility
public
final
false
static
false

getDijit
jump to class

getDijit( string $id ) : array|null

Retrieve a dijit by id

Arguments
$id
string
Output
array|null
Details
visibility
public
final
false
static
false

getDijits
jump to class

getDijits( ) : array

Retrieve all dijits

Returns dijits as an array of assoc arrays

Output
array
Details
visibility
public
final
false
static
false

getDjConfig
jump to class

getDjConfig( ) : array

Retrieve dojo configuration values

Output
array
Details
visibility
public
final
false
static
false

getDjConfigOption
jump to class

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

Get dojo configuration value

Arguments
$option
string
$default
mixed
Output
mixed
Details
visibility
public
final
false
static
false

getJavascript
jump to class

getJavascript( ) : array

Return all registered javascript statements

Output
array
Details
visibility
public
final
false
static
false

getLayers
jump to class

getLayers( ) : array

Get registered layers

Output
array
Details
visibility
public
final
false
static
false

getLocalPath
jump to class

getLocalPath( ) : string

Get local path to dojo

Output
string
Details
visibility
public
final
false
static
false

getModulePaths
jump to class

getModulePaths( ) : array

List registered module paths

Output
array
Details
visibility
public
final
false
static
false

getModules
jump to class

getModules( ) : array

Retrieve list of modules to require

Output
array
Details
visibility
public
final
false
static
false

getOnLoadActions
jump to class

getOnLoadActions( ) : array

Retrieve all registered onLoad actions

Output
array
Details
visibility
public
final
false
static
false

getStylesheetModules
jump to class

getStylesheetModules( ) : array

Get all stylesheet modules currently registered

Output
array
Details
visibility
public
final
false
static
false

getStylesheets
jump to class

getStylesheets( ) : array

Retrieve registered stylesheets

Output
array
Details
visibility
public
final
false
static
false

hasDijit
jump to class

hasDijit( string $id ) : bool

Is the given programmatic dijit already registered?

Arguments
$id
string
Output
bool
Details
visibility
public
final
false
static
false

isEnabled
jump to class

isEnabled( ) : bool

Is dojo enabled?

Output
bool
Details
visibility
public
final
false
static
false

javascriptCaptureEnd
jump to class

javascriptCaptureEnd( ) : true

Finish capturing arbitrary javascript to include in dojo script

Output
true
Details
visibility
public
final
false
static
false

javascriptCaptureStart
jump to class

javascriptCaptureStart( ) : void

Capture arbitrary javascript to include in dojo script

Details
visibility
public
final
false
static
false

onLoadCaptureEnd
jump to class

onLoadCaptureEnd( ) : bool

Stop capturing routines to run onLoad

Output
bool
Details
visibility
public
final
false
static
false

onLoadCaptureStart
jump to class

onLoadCaptureStart( ) : bool

Start capturing routines to run onLoad

Output
bool
Details
visibility
public
final
false
static
false

prependOnLoad
jump to class

prependOnLoad( string $callback ) : Zend_Dojo_View_Helper_Dojo_Container

Prepend an onLoad event to the list of onLoad actions

Arguments
$callback
string
Lambda
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

registerDijitLoader
jump to class

registerDijitLoader( ) : void

Create dijit loader functionality

Details
visibility
public
final
false
static
false

registerDojoStylesheet
jump to class

registerDojoStylesheet( null|bool $flag = null ) : Zend_Dojo_View_Helper_Dojo_Container|bool

Register the dojo.css stylesheet?

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

Arguments
$flag
nullbool
Output
Zend_Dojo_View_Helper_Dojo_Container|bool
Details
visibility
public
final
false
static
false

registerModulePath
jump to class

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

Register a module path

Arguments
$module
string
The module to register a path for
$path
string
The path to register for the module
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

removeDijit
jump to class

removeDijit( string $id ) : Zend_Dojo_View_Helper_Dojo_Container

Remove a programmatic dijit if it exists

Arguments
$id
string
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

removeLayer
jump to class

removeLayer( string $path ) : Zend_Dojo_View_Helper_Dojo_Container

Remove a registered layer

Arguments
$path
string
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

requireModule
jump to class

requireModule( string|array $modules ) : Zend_Dojo_View_Helper_Dojo_Container

Specify one or multiple modules to require

Arguments
$modules
stringarray
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

setCdnBase
jump to class

setCdnBase( string $url ) : Zend_Dojo_View_Helper_Dojo_Container

Set CDN base path

Arguments
$url
string
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

setCdnDojoPath
jump to class

setCdnDojoPath( string $path ) : Zend_Dojo_View_Helper_Dojo_Container

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

Arguments
$path
string
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

setCdnVersion
jump to class

setCdnVersion( string $version = null ) : Zend_Dojo_View_Helper_Dojo_Container

Use CDN, using version specified

Arguments
$version
string
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

setDijit
jump to class

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

Set a programmatic dijit (overwrites)

Arguments
$id
string
$params
array
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

setDijits
jump to class

setDijits( array $dijits ) : Zend_Dojo_View_Helper_Dojo_Container

Set multiple dijits at once (overwrites)

Expects an array of id => array $params pairs

Arguments
$dijits
array
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

setDjConfig
jump to class

setDjConfig(  $config ) : Zend_Dojo_View_Helper_Dojo_Container

Set Dojo configuration

Arguments
$config
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

setDjConfigOption
jump to class

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

Set Dojo configuration option

Arguments
$option
string
$value
mixed
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

setLocalPath
jump to class

setLocalPath( string $path ) : Zend_Dojo_View_Helper_Dojo_Container

Set path to local dojo

Arguments
$path
string
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

setOptions
jump to class

setOptions( array|Zend_Config $options ) : Zend_Dojo_View_Helper_Dojo_Container

Add options for the Dojo Container to use

Arguments
$options
arrayZend_Config
Array or Zend_Config object with options to use
Output
Zend_Dojo_View_Helper_Dojo_Container
Details
visibility
public
final
false
static
false

setView
jump to class

setView( Zend_Dojo_View_Interface $view ) : void

Set view object

Arguments
$view
Zend_Dojo_View_Interface
Details
visibility
public
final
false
static
false

useCdn
jump to class

useCdn( ) : bool

Are we using the CDN?

Output
bool
Details
visibility
public
final
false
static
false

useLocalPath
jump to class

useLocalPath( ) : bool

Are we using a local path?

Output
bool
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.