Dojo/View/Helper/Dojo/Container.php

Show:

inherited

Classes
- \Zend_Dojo_View_Helper_Dojo_Container

Table of Contents

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Dojo
Subpackage: View
Version: $Id$

\Zend_Dojo_View_Helper_Dojo_Container
jump to top

Package: Zend_Dojo\View

Container for Dojo View Helper

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

Properties

bool $_captureLock = false

addOnLoad capture lock

Default valuefalseDetails

Type: bool

string $_captureObj

addOnLoad object on which to apply lambda

Details

Type: string

string $_cdnBase = \Zend_Dojo::CDN_BASE_GOOGLE

Base CDN url to utilize

Default value\Zend_Dojo::CDN_BASE_GOOGLEDetails

Type: string

string $_cdnDojoPath = \Zend_Dojo::CDN_DOJO_PATH_GOOGLE

Path segment following version string of CDN path

Default value\Zend_Dojo::CDN_DOJO_PATH_GOOGLEDetails

Type: string

string $_cdnVersion = '1.5.0'

Dojo version to use from CDN

Default value'1.5.0'Details

Type: string

bool $_dijitLoaderRegistered = false

Has the dijit loader been registered?

Default valuefalseDetails

Type: bool

array $_dijits = array()

Registered programmatic dijits

Default valuearray()Details

Type: array

array $_djConfig = array()

Dojo configuration

Default valuearray()Details

Type: array

bool $_enabled = false

Whether or not dojo is enabled

Default valuefalseDetails

Type: bool

bool $_isXhtml = false

Are we rendering as XHTML?

Default valuefalseDetails

Type: bool

array $_javascriptStatements = array()

Arbitrary javascript to include in dojo script

Default valuearray()Details

Type: array

array $_layers = array()

Dojo layers (custom builds) to use

Default valuearray()Details

Type: array

string $_localPath = null

Relative path to dojo

Default valuenullDetails

Type: string

string $_localRelativePath = null

Root of dojo where all dojo files are installed

Default valuenullDetails

Type: string

array $_modulePaths = array()

Registered module paths

Default valuearray()Details

Type: array

array $_modules = array()

Modules to require

Default valuearray()Details

Type: array

array $_onLoadActions = array()

Actions to perform on window load

Default valuearray()Details

Type: array

bool $_registerDojoStylesheet = false

Default valuefalseDetails

Type: bool

array $_stylesheetModules = array()

Style sheet modules to load

Default valuearray()Details

Type: array

array $_stylesheets = array()

Local stylesheets

Default valuearray()Details

Type: array

array $_zendLoadActions = array()

Array of onLoad events specific to Zend_Dojo integration operations

Default valuearray()Details

Type: array

\Zend_View_Interface $view

Details

Type: \Zend_View_Interface

Methods

__toString() : string

String representation of dojo environment

Returns

Type	Description
string

_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.

Parameters

Name	Type	Description
$callback	string

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

_getLocalRelativePath() : string

Retrieve local path to dojo resources for building relative paths

Returns

Type	Description
string

_getZendLoadActions() : array

Retrieve all ZF dijit callbacks

Returns

Type	Description
array

_renderDjConfig() : string

Render DjConfig values

Returns

Type	Description
string

_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.

Returns

Type	Description
string

_renderExtras() : string

Render dojo module paths and requires

Returns

Type	Description
string

_renderLayers() : string

Render layers (custom builds) as script tags

Returns

Type	Description
string

_renderStylesheets() : string

Render dojo stylesheets

Returns

Type	Description
string

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

Add a programmatic dijit

Parameters

Name	Type	Description
$id	string
$params	array

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

addDijits(array $dijits) : \Zend_Dojo_View_Helper_Dojo_Container

Add multiple dijits at once

Expects an array of id => array $params pairs

Parameters

Name	Type	Description
$dijits	array

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

addJavascript(string $js) : \Zend_Dojo_View_Helper_Dojo_Container

Add arbitrary javascript to execute in dojo JS container

Parameters

Name	Type	Description
$js	string

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

addLayer(string $path) : \Zend_Dojo_View_Helper_Dojo_Container

Add layer (custom build) path

Parameters

Name	Type	Description
$path	string

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

addOnLoad(string $callback) : \Zend_Dojo_View_Helper_Dojo_Container

Add a script to execute onLoad

dojo.addOnLoad accepts: - function name - lambda

Parameters

Name	Type	Description
$callback	string	Lambda

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

addStylesheet(string $path) : \Zend_Dojo_View_Helper_Dojo_Container

Add a stylesheet

Parameters

Name	Type	Description
$path	string

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

addStylesheetModule(string $module) : \Zend_Dojo_View_Helper_Dojo_Container

Add a stylesheet by module name

Parameters

Name	Type	Description
$module	string

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

clearDijits() : \Zend_Dojo_View_Helper_Dojo_Container

Clear all dijits

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

clearJavascript() : \Zend_Dojo_View_Helper_Dojo_Container

Clear arbitrary javascript stack

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

clearLayers() : \Zend_Dojo_View_Helper_Dojo_Container

Clear all registered layers

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

dijitsToJson() : string

Render dijits as JSON structure

Returns

Type	Description
string

disable() : \Zend_Dojo_View_Helper_Dojo_Container

Disable dojo

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

enable() : \Zend_Dojo_View_Helper_Dojo_Container

Enable dojo

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

getCdnBase() : string

Return CDN base URL

Returns

Type	Description
string

getCdnDojoPath() : string

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

Returns

Type	Description
string

getCdnVersion() : string

Get CDN version

Returns

Type	Description
string

getDijit(string $id) : array | null

Retrieve a dijit by id

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
array \| null

getDijits() : array

Retrieve all dijits

Returns dijits as an array of assoc arrays

Returns

Type	Description
array

getDjConfig() : array

Retrieve dojo configuration values

Returns

Type	Description
array

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

Get dojo configuration value

Parameters

Name	Type	Description
$option	string
$default	mixed

Returns

Type	Description
mixed

getJavascript() : array

Return all registered javascript statements

Returns

Type	Description
array

getLayers() : array

Get registered layers

Returns

Type	Description
array

getLocalPath() : string

Get local path to dojo

Returns

Type	Description
string

getModulePaths() : array

List registered module paths

Returns

Type	Description
array

getModules() : array

Retrieve list of modules to require

Returns

Type	Description
array

getOnLoadActions() : array

Retrieve all registered onLoad actions

Returns

Type	Description
array

getStylesheetModules() : array

Get all stylesheet modules currently registered

Returns

Type	Description
array

getStylesheets() : array

Retrieve registered stylesheets

Returns

Type	Description
array

hasDijit(string $id) : bool

Is the given programmatic dijit already registered?

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
bool

isEnabled() : bool

Is dojo enabled?

Returns

Type	Description
bool

javascriptCaptureEnd() : true

Finish capturing arbitrary javascript to include in dojo script

Returns

Type	Description
true

javascriptCaptureStart() : void

Capture arbitrary javascript to include in dojo script

onLoadCaptureEnd() : bool

Stop capturing routines to run onLoad

Returns

Type	Description
bool

onLoadCaptureStart() : bool

Start capturing routines to run onLoad

Returns

Type	Description
bool

prependOnLoad(string $callback) : \Zend_Dojo_View_Helper_Dojo_Container

Prepend an onLoad event to the list of onLoad actions

Parameters

Name	Type	Description
$callback	string	Lambda

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

registerDijitLoader() : void

Create dijit loader functionality

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

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

Parameters

Name	Type	Description
$flag	null \| bool

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container \| bool

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

Parameters

Name	Type	Description
$module	string	The module to register a path for
$path	string	The path to register for the module

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

removeDijit(string $id) : \Zend_Dojo_View_Helper_Dojo_Container

Remove a programmatic dijit if it exists

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

removeLayer(string $path) : \Zend_Dojo_View_Helper_Dojo_Container

Remove a registered layer

Parameters

Name	Type	Description
$path	string

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

requireModule(string | array $modules) : \Zend_Dojo_View_Helper_Dojo_Container

Specify one or multiple modules to require

Parameters

Name	Type	Description
$modules	string \| array

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

setCdnBase(string $url) : \Zend_Dojo_View_Helper_Dojo_Container

Set CDN base path

Parameters

Name	Type	Description
$url	string

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

setCdnDojoPath(string $path) : \Zend_Dojo_View_Helper_Dojo_Container

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

Parameters

Name	Type	Description
$path	string

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

setCdnVersion(string $version = null) : \Zend_Dojo_View_Helper_Dojo_Container

Use CDN, using version specified

Parameters

Name	Type	Description
$version	string

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

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

Set a programmatic dijit (overwrites)

Parameters

Name	Type	Description
$id	string
$params	array

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

setDijits(array $dijits) : \Zend_Dojo_View_Helper_Dojo_Container

Set multiple dijits at once (overwrites)

Expects an array of id => array $params pairs

Parameters

Name	Type	Description
$dijits	array

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

setDjConfig( $config) : \Zend_Dojo_View_Helper_Dojo_Container

Set Dojo configuration

Parameters

Name	Type	Description
$config

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

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

Set Dojo configuration option

Parameters

Name	Type	Description
$option	string
$value	mixed

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

setLocalPath(string $path) : \Zend_Dojo_View_Helper_Dojo_Container

Set path to local dojo

Parameters

Name	Type	Description
$path	string

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

setOptions( $options) : \Zend_Dojo_View_Helper_Dojo_Container

Add options for the Dojo Container to use

Parameters

Name	Type	Description
$options

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

setView(\Zend_Dojo_View_Interface $view) : void

Set view object

Parameters

Name	Type	Description
$view	\Zend_Dojo_View_Interface

useCdn() : bool

Are we using the CDN?

Returns

Type	Description
bool

useLocalPath() : bool

Are we using a local path?

Returns

Type	Description
bool

Dojo/View/Helper/Dojo/Container.php

\Zend_Dojo_View_Helper_Dojo_Containerjump to top

Properties

Methods

\Zend_Dojo_View_Helper_Dojo_Container
jump to top