Dojo/BuildLayer.php

Show:

inherited

Classes
- \Zend_Dojo_BuildLayer

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
Version: $Id$

\Zend_Dojo_BuildLayer
jump to top

Package: Zend_Dojo

Dojo module layer and custom build profile generation support

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

Properties

bool $_consumeJavascript = false

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

Default valuefalseDetails

Type: bool

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

Default valuefalseDetails

Type: bool

\Zend_Dojo_View_Helper_Dojo_Container $_dojo

Dojo view helper reference

Details

Type: \Zend_Dojo_View_Helper_Dojo_Container

string $_layerName

Name of the custom layer to generate

Details

Type: string

string $_layerScriptPath

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

Details

Type: string

array $_profileOptions = array('action' => 'release', 'optimize' => 'shrinksafe', 'layerOptimize' => 'shrinksafe', 'copyTests' => false, 'loader' => 'default', 'cssOptimize' => 'comments')

Build profile options

Default value

array('action' => 'release', 'optimize' => 'shrinksafe', 'layerOptimize' => 'shrinksafe', 'copyTests' => false, 'loader' => 'default', 'cssOptimize' => 'comments')

Details

Type: array

array $_profilePrefixes = array()

Associative array of module/path pairs for the build profile

Default valuearray()Details

Type: array

\Zend_View_Interface $_view

Zend_View reference

Details

Type: \Zend_View_Interface

Methods

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

Constructor

Parameters

Name	Type	Description
$options	array \| \Zend_Config

Throws

Exception	Description
\Zend_Dojo_Exception	for invalid option argument

_filterJsonProfileToJavascript(string $profile) : string

Filter a JSON build profile to JavaScript

Parameters

Name	Type	Description
$profile	string

Returns

Type	Description
string

_getPrefix(string $module) : void

Retrieve module prefix

Parameters

Name	Type	Description
$module	string

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

Add a single build profile option

Parameters

Name	Type	Description
$key	string
$value	\value

Returns

Type	Description
\Zend_Dojo_BuildLayer

addProfileOptions(array $options) : \Zend_Dojo_BuildLayer

Add many build profile options at once

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Dojo_BuildLayer

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

Parameters

Name	Type	Description
$prefix	string
$path	null \| string

Returns

Type	Description
\Zend_Dojo_BuildLayer

clearProfileOptions() : \Zend_Dojo_BuildLayer

Remove all build profile options

Returns

Type	Description
\Zend_Dojo_BuildLayer

consumeJavascript() : bool

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

Returns

Type	Description
bool

consumeOnLoad() : bool

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

Returns

Type	Description
bool

generateBuildProfile() : string

Generate build profile

Returns

Type	Description
string

generateLayerScript() : string

Generate module layer script

Returns

Type	Description
string

getDojoHelper() : \Zend_Dojo_View_Helper_Dojo_Container

Retrieve dojo() view helper instance

Will retrieve it from the view object if not registered.

Returns

Type	Description
\Zend_Dojo_View_Helper_Dojo_Container

Throws

Exception	Description
\Zend_Dojo_Exception	if not registered and no view object found

getLayerName() : string | null

Retrieve custom layer name

Returns

Type	Description
string \| null

getLayerScriptPath() : string | null

Get custom layer script path

Returns

Type	Description
string \| null

getProfileOption(string $key) : mixed

Retrieve a single build profile option

Returns null if profile option does not exist.

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

getProfileOptions() : array

Get all build profile options

Returns

Type	Description
array

getProfilePrefixes() : array

Get build profile dependency prefixes

Returns

Type	Description
array

getView() : \Zend_View_Interface | null

Retrieve view object

Returns

Type	Description
\Zend_View_Interface \| null

hasProfileOption(string $key) : bool

Is a given build profile option set?

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
bool

removeProfileOption(string $name) : \Zend_Dojo_BuildLayer

Remove a build profile option

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Dojo_BuildLayer

setConsumeJavascript(bool $flag) : \Zend_Dojo_BuildLayer

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

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Dojo_BuildLayer

setConsumeOnLoad(bool $flag) : \Zend_Dojo_BuildLayer

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

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_Dojo_BuildLayer

setDojoHelper(\Zend_Dojo_View_Helper_Dojo_Container $helper) : \Zend_Dojo_BuildLayer

Set dojo() view helper instance

Parameters

Name	Type	Description
$helper	\Zend_Dojo_View_Helper_Dojo_Container

Returns

Type	Description
\Zend_Dojo_BuildLayer

setLayerName(string $name) : \Zend_Dojo_BuildLayer

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

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Dojo_BuildLayer

setLayerScriptPath(string $path) : \Zend_Dojo_BuildLayer

Set the path to the custom layer script

Should be a path relative to dojo.js

Parameters

Name	Type	Description
$path	string

Returns

Type	Description
\Zend_Dojo_BuildLayer

setOptions(array $options) : \Zend_Dojo_BuildLayer

Set options

Proxies to any setter that matches an option key.

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Dojo_BuildLayer

setProfileOptions(array $options) : \Zend_Dojo_BuildLayer

Set many build profile options at once

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Dojo_BuildLayer

setProfilePrefixes(array $prefixes) : \Zend_Dojo_BuildLayer

Set multiple dependency prefixes for bulid profile

Parameters

Name	Type	Description
$prefixes	array

Returns

Type	Description
\Zend_Dojo_BuildLayer

setView(\Zend_View_Interface $view) : \Zend_Dojo_BuildLayer

Set View object

Parameters

Name	Type	Description
$view	\Zend_View_Interface

Returns

Type	Description
\Zend_Dojo_BuildLayer

Dojo/BuildLayer.php

\Zend_Dojo_BuildLayerjump to top

Properties

Methods

\Zend_Dojo_BuildLayer
jump to top