API Documentation

JQuery/View/Helper/JQuery/Container.php

Includes Classes 
category
ZendX
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
ZendX_JQuery
subpackage
View
version
$Id: Container.php 20750 2010-01-29 11:12:00Z beberlei $
Classes
ZendX_JQuery_View_Helper_JQuery_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.

ZendX_JQuery_View_Helper_JQuery_Container

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
ZendX_JQuery
subpackage
View
uses
ZendX_JQuery_View_Helper_JQuery_Container
Properties
$_jqueryLibraryPath
$_javascriptSources
$_enabled
$_captureLock
$_javascriptStatements
$_stylesheets
$_onLoadActions
$_isXhtml
$_version
$_renderMode
$_uiEnabled
$_uiPath
$_uiVersion
$_loadSslCdnPath
$view
Methods
setView
enable
disable
isEnabled
setVersion
getVersion
setCdnVersion
getCdnVersion
setCdnSsl
useCdn
setLocalPath
uiEnable
uiDisable
uiIsEnabled
setUiVersion
getUiVersion
setUiCdnVersion
getUiCdnVersion
setUiLocalPath
getUiPath
getUiLocalPath
useUiLocal
useUiCdn
getLocalPath
useLocalPath
onLoadCaptureStart
onLoadCaptureEnd
javascriptCaptureStart
javascriptCaptureEnd
addJavascriptFile
getJavascriptFiles
clearJavascriptFiles
addJavascript
getJavascript
clearJavascript
addStylesheet
getStylesheets
addOnLoad
getOnLoadActions
clearOnLoadActions
setRenderMode
getRenderMode
__toString
_renderStylesheets
_renderScriptTags
_renderExtras
_getJQueryLibraryBaseCdnUri
_getJQueryUiLibraryBaseCdnUri
_getJQueryLibraryPath
_getJQueryUiLibraryPath

Description

jQuery View Helper. Transports all jQuery stack and render information across all views.

Properties

$_captureLock

Boolean $_captureLock = 'false'

Indicates if a capture start method for javascript or onLoad has been called.

Details

$_captureLock
Boolean
visibility
protected
default
false
final
false
static
false

$_enabled

Boolean $_enabled = 'false'

Indicates wheater the jQuery View Helper is enabled.

Details

$_enabled
Boolean
visibility
protected
default
false
final
false
static
false

$_isXhtml

Boolean $_isXhtml = 'false'

View is rendered in XHTML or not.

Details

$_isXhtml
Boolean
visibility
protected
default
false
final
false
static
false

$_javascriptSources

Array $_javascriptSources = 'array'

Additional javascript files that for jQuery Helper components.

Details

$_javascriptSources
Array
visibility
protected
default
array
final
false
static
false

$_javascriptStatements

Array $_javascriptStatements = 'array'

Additional javascript statements that need to be executed after jQuery lib.

Details

$_javascriptStatements
Array
visibility
protected
default
array
final
false
static
false

$_jqueryLibraryPath

String $_jqueryLibraryPath = 'null'

Path to local webserver jQuery library

Details

$_jqueryLibraryPath
String
visibility
protected
default
null
final
false
static
false

$_loadSslCdnPath

boolean $_loadSslCdnPath = 'false'

Load CDN Path from SSL or Non-SSL?

Details

$_loadSslCdnPath
boolean
visibility
protected
default
false
final
false
static
false

$_onLoadActions

Array $_onLoadActions = 'array'

jQuery onLoad statements Stack

Details

$_onLoadActions
Array
visibility
protected
default
array
final
false
static
false

$_renderMode

Integer $_renderMode = 'ZendX_JQuery'

Default Render Mode (all parts)

Details

$_renderMode
Integer
visibility
protected
default
ZendX_JQuery
final
false
static
false

$_stylesheets

Array $_stylesheets = 'array'

Additional stylesheet files for jQuery related components.

Details

$_stylesheets
Array
visibility
protected
default
array
final
false
static
false

$_uiEnabled

Boolean $_uiEnabled = 'false'

jQuery UI Library Enabled

Details

$_uiEnabled
Boolean
visibility
protected
default
false
final
false
static
false

$_uiPath

String $_uiPath = 'null'

Local jQuery UI Path. Use Google CDN if variable is null

Details

$_uiPath
String
visibility
protected
default
null
final
false
static
false

$_uiVersion

String $_uiVersion = 'ZendX_JQuery'

jQuery UI Google CDN Version

Details

$_uiVersion
String
visibility
protected
default
ZendX_JQuery
final
false
static
false

$_version

String $_version = 'ZendX_JQuery'

Default CDN jQuery Library version

Details

$_version
String
visibility
protected
default
ZendX_JQuery
final
false
static
false

$view

Zend_View_Interface $view = 'null'

View Instance

Details

$view
Zend_View_Interface
visibility
public
default
null
final
false
static
false

Methods

__toString

__toString( ) : string

String representation of jQuery environment

Output
string
Details
visibility
public
final
false
static
false

_getJQueryLibraryBaseCdnUri

_getJQueryLibraryBaseCdnUri( ) : string

Output
string
Details
visibility
protected
final
false
static
false

_getJQueryLibraryPath

_getJQueryLibraryPath( ) : string

Internal function that constructs the include path of the jQuery library.

Output
string
Details
visibility
protected
final
false
static
false

_getJQueryUiLibraryBaseCdnUri

_getJQueryUiLibraryBaseCdnUri( ) : string

Output
string
Details
visibility
protected
final
false
static
false

_getJQueryUiLibraryPath

_getJQueryUiLibraryPath( ) : string

Output
string
Details
visibility
protected
final
false
static
false

_renderExtras

_renderExtras( ) : string

Renders all javascript code related stuff of the jQuery enviroment.

Output
string
Details
visibility
protected
final
false
static
false

_renderScriptTags

_renderScriptTags( ) : string

Renders all javascript file related stuff of the jQuery enviroment.

Output
string
Details
visibility
protected
final
false
static
false

_renderStylesheets

_renderStylesheets( ) : string

Render jQuery stylesheets

Output
string
Details
visibility
protected
final
false
static
false

addJavascript

addJavascript( string $js ) : ZendX_JQuery_View_Helper_JQuery_Container

Add arbitrary javascript to execute in jQuery JS container

Arguments
$js
string
Details
visibility
public
final
false
static
false

addJavascriptFile

addJavascriptFile(  $path ) : ZendX_JQuery_View_Helper_JQuery_Container

Add a Javascript File to the include stack.

Arguments
$path
Details
visibility
public
final
false
static
false

addOnLoad

addOnLoad( string $callback ) : ZendX_JQuery_View_Helper_JQuery_Container

Add a script to execute onLoad

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

addStylesheet

addStylesheet( string $path ) : ZendX_JQuery_View_Helper_JQuery_Container

Add a stylesheet

Arguments
$path
string
Details
visibility
public
final
false
static
false

clearJavascript

clearJavascript( ) : ZendX_JQuery_View_Helper_JQuery_Container

Clear arbitrary javascript stack

Details
visibility
public
final
false
static
false

clearJavascriptFiles

clearJavascriptFiles( ) : ZendX_JQuery_View_Helper_JQuery_Container

Clear all currently registered Javascript files.

Details
visibility
public
final
false
static
false

clearOnLoadActions

clearOnLoadActions( ) : ZendX_JQuery_View_Helper_JQuery_Container

Clear the onLoadActions stack.

Details
visibility
public
final
false
static
false

disable

disable( ) : ZendX_JQuery_View_Helper_JQuery_Container

Disable jQuery

Details
visibility
public
final
false
static
false

enable

enable( ) : ZendX_JQuery_View_Helper_JQuery_Container

Enable jQuery

Details
visibility
public
final
false
static
false

getCdnVersion

getCdnVersion( ) : string

Get CDN version

Output
string
Details
visibility
public
final
false
static
false
deprecated
As of version 1.8, use {@link getVersion()} instead.

getJavascript

getJavascript( ) : array

Return all registered javascript statements

Output
array
Details
visibility
public
final
false
static
false

getJavascriptFiles

getJavascriptFiles( ) : Array

Return all currently registered Javascript files.

This does not include the jQuery library, which is handled by another retrieval strategy.

Output
Array
Details
visibility
public
final
false
static
false

getLocalPath

getLocalPath( ) : string

Get local path to jQuery

Output
string
Details
visibility
public
final
false
static
false

getOnLoadActions

getOnLoadActions( ) : array

Retrieve all registered onLoad actions

Output
array
Details
visibility
public
final
false
static
false

getRenderMode

getRenderMode( ) : integer

Return bitmask of the current Render Mode

Output
integer
Details
visibility
public
final
false
static
false

getStylesheets

getStylesheets( ) : array

Retrieve registered stylesheets

Output
array
Details
visibility
public
final
false
static
false

getUiCdnVersion

getUiCdnVersion( ) : String

Return jQuery UI CDN Version

Output
String
Details
visibility
public
final
false
static
false
deprecated
As of 1.8 use {@link getUiVersion()}

getUiLocalPath

getUiLocalPath( ) : string

Proxies to getUiPath() for consistency in function naming.

Output
string
Details
visibility
public
final
false
static
false

getUiPath

getUiPath( ) : string

Return the local jQuery UI Path if set.

Output
string
Details
visibility
public
final
false
static
false

getUiVersion

getUiVersion( ) : string

Get jQuery UI Version used.

Output
string
Details
visibility
public
final
false
static
false

getVersion

getVersion( ) : string

Get the version used with the jQuery library

Output
string
Details
visibility
public
final
false
static
false

isEnabled

isEnabled( ) : boolean

Is jQuery enabled?

Output
boolean
Details
visibility
public
final
false
static
false

javascriptCaptureEnd

javascriptCaptureEnd( ) : boolean

Finish capturing arbitrary javascript to include in jQuery script

Output
boolean
Details
visibility
public
final
false
static
false

javascriptCaptureStart

javascriptCaptureStart( ) : boolean

Capture arbitrary javascript to include in jQuery script

Output
boolean
Details
visibility
public
final
false
static
false

onLoadCaptureEnd

onLoadCaptureEnd( ) : boolean

Stop capturing routines to run onLoad

Output
boolean
Details
visibility
public
final
false
static
false

onLoadCaptureStart

onLoadCaptureStart( ) : boolean

Start capturing routines to run onLoad

Output
boolean
Details
visibility
public
final
false
static
false

setCdnSsl

setCdnSsl(  $flag ) : ZendX_JQuery_View_Helper_JQuery_Container

Set Use SSL on CDN Flag

Arguments
$flag
Details
visibility
public
final
false
static
false

setCdnVersion

setCdnVersion( string $version = null ) : ZendX_JQuery_View_Helper_JQuery_Container

Use CDN, using version specified. Currently supported by Googles Ajax Library API are: 1.2.3, 1.2.6

Arguments
$version
string
Details
visibility
public
final
false
static
false
deprecated
As of version 1.8, use {@link setVersion()} instead.

setLocalPath

setLocalPath( string $path ) : ZendX_JQuery_View_Helper_JQuery_Container

Set path to local jQuery library

Arguments
$path
string
Details
visibility
public
final
false
static
false

setRenderMode

setRenderMode( integer $mask ) : ZendX_JQuery_View_Helper_JQuery_Container

Set which parts of the jQuery enviroment should be rendered.

This function allows for a gradual refactoring of the jQuery code rendered by calling __toString(). Use ZendX_JQuery::RENDER_* constants. By default all parts of the enviroment are rendered.

Arguments
$mask
integer
Details
visibility
public
final
false
static
false
see
ZendX_JQuery::RENDER_ALL

setUiCdnVersion

setUiCdnVersion( String $version = 1.5.2 ) : ZendX_JQuery_View_Helper_JQuery_Container

Set jQuery UI CDN Version

Arguments
$version
String
Details
visibility
public
final
false
static
false
deprecated
As of 1.8 use {@link setUiVersion()}

setUiLocalPath

setUiLocalPath( String $path ) : ZendX_JQuery_View_Helper_JQuery_Container

Set local path to jQuery UI library

Arguments
$path
String
Details
visibility
public
final
false
static
false

setUiVersion

setUiVersion( string $version ) : ZendX_JQuery_View_Helper_JQuery_Container

Set jQuery UI version used.

Arguments
$version
string
Details
visibility
public
final
false
static
false

setVersion

setVersion( string $version ) : ZendX_JQuery_View_Helper_JQuery_Container

Set the version of the jQuery library used.

Arguments
$version
string
Details
visibility
public
final
false
static
false

setView

setView( Zend_View_Interface $view ) : void

Set view object

Arguments
$view
Zend_View_Interface
Details
visibility
public
final
false
static
false

uiDisable

uiDisable( ) : ZendX_JQuery_View_Helper_JQuery_Container

Disable jQuery UI Library Rendering

Details
visibility
public
final
false
static
false

uiEnable

uiEnable( ) : ZendX_JQuery_View_Helper_JQuery_Container

Enable jQuery UI Library Rendering

Details
visibility
public
final
false
static
false

uiIsEnabled

uiIsEnabled( ) : boolean

Check wheater currently the jQuery UI library is enabled.

Output
boolean
Details
visibility
public
final
false
static
false

useCdn

useCdn( ) : boolean

Are we using the CDN?

Output
boolean
Details
visibility
public
final
false
static
false

useLocalPath

useLocalPath( ) : boolean

Are we using a local path?

Output
boolean
Details
visibility
public
final
false
static
false

useUiCdn

useUiCdn( ) : ZendX_JQuery_View_Helper_JQuery_Container

Is the jQuery Ui enabled and loaded from CDN?

Details
visibility
public
final
false
static
false

useUiLocal

useUiLocal( ) : boolean

Is the jQuery Ui loaded from local scope?

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