Dojo/BuildLayer.php

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
version: $Id: BuildLayer.php 22279 2010-05-24 20:38:52Z matthew $
Classes: Zend_Dojo_BuildLayer

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_BuildLayer
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
Properties: $_consumeJavascript; $_consumeOnLoad; $_dojo; $_layerName; $_layerScriptPath; $_profileOptions; $_profilePrefixes; $_view
Methods: __construct; setOptions; setView; getView; setDojoHelper; getDojoHelper; setLayerName; getLayerName; setLayerScriptPath; getLayerScriptPath; setConsumeJavascript; consumeJavascript; setConsumeOnLoad; consumeOnLoad; setProfileOptions; addProfileOptions; addProfileOption; hasProfileOption; getProfileOption; getProfileOptions; removeProfileOption; clearProfileOptions; addProfilePrefix; setProfilePrefixes; getProfilePrefixes; generateLayerScript; generateBuildProfile; _getPrefix; _filterJsonProfileToJavascript

Description

Dojo module layer and custom build profile generation support

Properties

$_consumeJavascript
jump to class

bool $_consumeJavascript = 'false'

Flag: whether or not to consume JS aggregated in the dojo() view helper when generate the module layer contents

Details

$_consumeJavascript: bool
visibility: protected
default: false
final: false
static: false

$_consumeOnLoad
jump to class

bool $_consumeOnLoad = 'false'

Flag: whether or not to consume dojo.addOnLoad events registered with the dojo() view helper when generating the module layer file contents

Details

$_consumeOnLoad: bool
visibility: protected
default: false
final: false
static: false

$_dojo
jump to class

Zend_Dojo_View_Helper_Dojo_Container $_dojo = ''

Dojo view helper reference

Details

$_dojo: Zend_Dojo_View_Helper_Dojo_Container
visibility: protected
default
final: false
static: false

$_layerName
jump to class

string $_layerName = ''

Name of the custom layer to generate

Details

$_layerName: string
visibility: protected
default
final: false
static: false

$_layerScriptPath
jump to class

string $_layerScriptPath = ''

Path to the custom layer script relative to dojo.js (used when creating the build profile)

Details

$_layerScriptPath: string
visibility: protected
default
final: false
static: false

$_profileOptions
jump to class

array $_profileOptions = 'array'

Build profile options

Details

$_profileOptions: array
visibility: protected
default: array
final: false
static: false

$_profilePrefixes
jump to class

array $_profilePrefixes = 'array'

Associative array of module/path pairs for the build profile

Details

$_profilePrefixes: array
visibility: protected
default: array
final: false
static: false

$_view
jump to class

Zend_View_Interface $_view = ''

Zend_View reference

Details

$_view: Zend_View_Interface
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

__construct(
          array|Zend_Config $options
              =
              null
          )
        
        :
        void

Constructor

Arguments

$options: arrayZend_Config

Details

visibility: public
final: false
static: false
throws: for invalid option argument

_filterJsonProfileToJavascript
jump to class

_filterJsonProfileToJavascript(
          string $profile
          )
        
        :
        string

Filter a JSON build profile to JavaScript

Arguments

$profile: string

Output

string

Details

visibility: protected
final: false
static: false

_getPrefix
jump to class

_getPrefix(
          string $module
          )
        
        :
        void

Retrieve module prefix

Arguments

$module: string

Details

visibility: protected
final: false
static: false

addProfileOption
jump to class

addProfileOption(
          string $key, value $value
          )
        
        :
        Zend_Dojo_BuildLayer

Add a single build profile option

Arguments

$key: string
$value: value

Output

Zend_Dojo_BuildLayer

Details

visibility: public
final: false
static: false

addProfileOptions
jump to class

addProfileOptions(
          array $options
          )
        
        :
        Zend_Dojo_BuildLayer

Add many build profile options at once

Arguments

$options: array

Output

Zend_Dojo_BuildLayer

Details

visibility: public
final: false
static: false

addProfilePrefix
jump to class

addProfilePrefix(
          string $prefix, null|string $path
              =
              null
          )
        
        :
        Zend_Dojo_BuildLayer

Add a build profile dependency prefix

If just the prefix is passed, sets path to "../$prefix".

Arguments

$prefix: string
$path: nullstring

Output

Zend_Dojo_BuildLayer

Details

visibility: public
final: false
static: false

clearProfileOptions
jump to class

clearProfileOptions(
          
          )
        
        :
        Zend_Dojo_BuildLayer

Remove all build profile options

Output

Zend_Dojo_BuildLayer

Details

visibility: public
final: false
static: false

consumeJavascript
jump to class

consumeJavascript(
          
          )
        
        :
        bool

Get flag indicating whether or not to consume JS aggregated in dojo() view helper

Output

bool

Details

visibility: public
final: false
static: false

consumeOnLoad
jump to class

consumeOnLoad(
          
          )
        
        :
        bool

Get flag indicating whether or not to consume dojo.addOnLoad events aggregated in dojo() view helper

Output

bool

Details

visibility: public
final: false
static: false

generateBuildProfile
jump to class

generateBuildProfile(
          
          )
        
        :
        string

Generate build profile

Output

string

Details

visibility: public
final: false
static: false

generateLayerScript
jump to class

generateLayerScript(
          
          )
        
        :
        string

Generate module layer script

Output

string

Details

visibility: public
final: false
static: false

getDojoHelper
jump to class

getDojoHelper(
          
          )
        
        :
        Zend_Dojo_View_Helper_Dojo_Container

Retrieve dojo() view helper instance

Will retrieve it from the view object if not registered.

Output

Zend_Dojo_View_Helper_Dojo_Container

Details

visibility: public
final: false
static: false
throws: if not registered and no view object found

getLayerName
jump to class

getLayerName(
          
          )
        
        :
        string|null

Retrieve custom layer name

Output

string|null

Details

visibility: public
final: false
static: false

getLayerScriptPath
jump to class

getLayerScriptPath(
          
          )
        
        :
        string|null

Get custom layer script path

Output

string|null

Details

visibility: public
final: false
static: false

getProfileOption
jump to class

getProfileOption(
          string $key
          )
        
        :
        mixed

Retrieve a single build profile option

Returns null if profile option does not exist.

Arguments

$key: string

Output

mixed

Details

visibility: public
final: false
static: false

getProfileOptions
jump to class

getProfileOptions(
          
          )
        
        :
        array

Get all build profile options

Output

array

Details

visibility: public
final: false
static: false

getProfilePrefixes
jump to class

getProfilePrefixes(
          
          )
        
        :
        array

Get build profile dependency prefixes

Output

array

Details

visibility: public
final: false
static: false

getView
jump to class

getView(
          
          )
        
        :
        Zend_View_Interface|null

Retrieve view object

Output

Zend_View_Interface|null

Details

visibility: public
final: false
static: false

hasProfileOption
jump to class

hasProfileOption(
          string $key
          )
        
        :
        bool

Is a given build profile option set?

Arguments

$key: string

Output

bool

Details

visibility: public
final: false
static: false

removeProfileOption
jump to class

removeProfileOption(
          string $name
          )
        
        :
        Zend_Dojo_BuildLayer

Remove a build profile option

Arguments

$name: string

Output

Zend_Dojo_BuildLayer

Details

visibility: public
final: false
static: false

setConsumeJavascript
jump to class

setConsumeJavascript(
          bool $flag
          )
        
        :
        Zend_Dojo_BuildLayer

Set flag indicating whether or not to consume JS aggregated in dojo() view helper

Arguments

$flag: bool

Output

Zend_Dojo_BuildLayer

Details

visibility: public
final: false
static: false

setConsumeOnLoad
jump to class

setConsumeOnLoad(
          bool $flag
          )
        
        :
        Zend_Dojo_BuildLayer

Set flag indicating whether or not to consume dojo.addOnLoad events aggregated in dojo() view helper

Arguments

$flag: bool

Output

Zend_Dojo_BuildLayer

Details

visibility: public
final: false
static: false

setDojoHelper
jump to class

setDojoHelper(
          Zend_Dojo_View_Helper_Dojo_Container $helper
          )
        
        :
        Zend_Dojo_BuildLayer

Set dojo() view helper instance

Arguments

$helper: Zend_Dojo_View_Helper_Dojo_Container

Output

Zend_Dojo_BuildLayer

Details

visibility: public
final: false
static: false

setLayerName
jump to class

setLayerName(
          string $name
          )
        
        :
        Zend_Dojo_BuildLayer

Set custom layer name; e.g. "custom.main"

Arguments

$name: string

Output

Zend_Dojo_BuildLayer

Details

visibility: public
final: false
static: false

setLayerScriptPath
jump to class

setLayerScriptPath(
          string $path
          )
        
        :
        Zend_Dojo_BuildLayer

Set the path to the custom layer script

Should be a path relative to dojo.js

Arguments

$path: string

Output

Zend_Dojo_BuildLayer

Details

visibility: public
final: false
static: false

setOptions
jump to class

setOptions(
          array $options
          )
        
        :
        Zend_Dojo_BuildLayer

Set options

Proxies to any setter that matches an option key.

Arguments

$options: array

Output

Zend_Dojo_BuildLayer

Details

visibility: public
final: false
static: false

setProfileOptions
jump to class

setProfileOptions(
          array $options
          )
        
        :
        Zend_Dojo_BuildLayer

Set many build profile options at once

Arguments

$options: array

Output

Zend_Dojo_BuildLayer

Details

visibility: public
final: false
static: false

setProfilePrefixes
jump to class

setProfilePrefixes(
          array $prefixes
          )
        
        :
        Zend_Dojo_BuildLayer

Set multiple dependency prefixes for bulid profile

Arguments

$prefixes: array

Output

Zend_Dojo_BuildLayer

Details

visibility: public
final: false
static: false

setView
jump to class

setView(
          Zend_View_Interface $view
          )
        
        :
        Zend_Dojo_BuildLayer

Set View object

Arguments

$view: Zend_View_Interface

Output

Zend_Dojo_BuildLayer

Details

visibility: public
final: false
static: false

API Documentation

Dojo/BuildLayer.php

Description

Zend_Dojo_BuildLayerjump to top

Description

Properties

$_consumeJavascriptjump to class

Details

$_consumeOnLoadjump to class

Details

$_dojojump to class

Details

$_layerNamejump to class

Details

$_layerScriptPathjump to class

Details

$_profileOptionsjump to class

Details

$_profilePrefixesjump to class

Details

$_viewjump to class

Details

Methods

__constructjump to class

Arguments

Details

_filterJsonProfileToJavascriptjump to class

Arguments

Output

Details

_getPrefixjump to class

Arguments

Details

addProfileOptionjump to class

Arguments

Output

Details

addProfileOptionsjump to class

Arguments

Output

Details

addProfilePrefixjump to class

Arguments

Output

Details

clearProfileOptionsjump to class

Output

Details

consumeJavascriptjump to class

Output

Details

consumeOnLoadjump to class

Output

Details

generateBuildProfilejump to class

Output

Details

generateLayerScriptjump to class

Output

Details

getDojoHelperjump to class

Output

Details

getLayerNamejump to class

Output

Details

getLayerScriptPathjump to class

Output

Details

getProfileOptionjump to class

Arguments

Output

Details

getProfileOptionsjump to class

Output

Details

getProfilePrefixesjump to class

Output

Details

getViewjump to class

Zend_Dojo_BuildLayer
jump to top

$_consumeJavascript
jump to class

$_consumeOnLoad
jump to class

$_dojo
jump to class

$_layerName
jump to class

$_layerScriptPath
jump to class

$_profileOptions
jump to class

$_profilePrefixes
jump to class

$_view
jump to class

__construct
jump to class

_filterJsonProfileToJavascript
jump to class

_getPrefix
jump to class

addProfileOption
jump to class

addProfileOptions
jump to class

addProfilePrefix
jump to class

clearProfileOptions
jump to class

consumeJavascript
jump to class

consumeOnLoad
jump to class

generateBuildProfile
jump to class

generateLayerScript
jump to class

getDojoHelper
jump to class

getLayerName
jump to class

getLayerScriptPath
jump to class

getProfileOption
jump to class

getProfileOptions
jump to class

getProfilePrefixes
jump to class

getView
jump to class

hasProfileOption
jump to class

removeProfileOption
jump to class

setConsumeJavascript
jump to class

setConsumeOnLoad
jump to class

setDojoHelper
jump to class

setLayerName
jump to class

setLayerScriptPath
jump to class

setOptions
jump to class

setProfileOptions
jump to class

setProfilePrefixes
jump to class

setView
jump to class