Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes

ZendX_JQuery_View_Helper_JQuery_Container Class Reference

Public Member Functions

 setView (Zend_View_Interface $view)
 enable ()
 disable ()
 isEnabled ()
 setVersion ($version)
 getVersion ()
 setCdnVersion ($version=null)
 getCdnVersion ()
 setCdnSsl ($flag)
 useCdn ()
 setLocalPath ($path)
 uiEnable ()
 uiDisable ()
 uiIsEnabled ()
 setUiVersion ($version)
 getUiVersion ()
 setUiCdnVersion ($version="1.5.2")
 getUiCdnVersion ()
 setUiLocalPath ($path)
 getUiPath ()
 getUiLocalPath ()
 useUiLocal ()
 useUiCdn ()
 getLocalPath ()
 useLocalPath ()
 onLoadCaptureStart ()
 onLoadCaptureEnd ()
 javascriptCaptureStart ()
 javascriptCaptureEnd ()
 addJavascriptFile ($path)
 getJavascriptFiles ()
 clearJavascriptFiles ()
 addJavascript ($js)
 getJavascript ()
 clearJavascript ()
 addStylesheet ($path)
 getStylesheets ()
 addOnLoad ($callback)
 getOnLoadActions ()
 clearOnLoadActions ()
 setRenderMode ($mask)
 getRenderMode ()
 __toString ()

Data Fields

 $view = null

Protected Member Functions

 _renderStylesheets ()
 _renderScriptTags ()
 _renderExtras ()
 _getJQueryLibraryBaseCdnUri ()
 _getJQueryUiLibraryBaseCdnUri ()
 _getJQueryLibraryPath ()
 _getJQueryUiLibraryPath ()

Protected Attributes

 $_jqueryLibraryPath = null
 $_javascriptSources = array()
 $_enabled = false
 $_captureLock = false
 $_javascriptStatements = array()
 $_stylesheets = array()
 $_onLoadActions = array()
 $_isXhtml = false
 $_version = ZendX_JQuery::DEFAULT_JQUERY_VERSION
 $_renderMode = ZendX_JQuery::RENDER_ALL
 $_uiEnabled = false
 $_uiPath = null
 $_uiVersion = ZendX_JQuery::DEFAULT_UI_VERSION
 $_loadSslCdnPath = false

Detailed Description

Definition at line 37 of file Container.php.


Member Function Documentation

__toString (  )

String representation of jQuery environment

Returns:
string

Definition at line 642 of file Container.php.

_getJQueryLibraryBaseCdnUri (  ) [protected]
Returns:
string

Definition at line 773 of file Container.php.

_getJQueryLibraryPath (  ) [protected]

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

Returns:
string

Definition at line 801 of file Container.php.

_getJQueryUiLibraryBaseCdnUri (  ) [protected]
Returns:
string

Definition at line 786 of file Container.php.

_getJQueryUiLibraryPath (  ) [protected]
Returns:
string

Definition at line 819 of file Container.php.

_renderExtras (  ) [protected]

Renders all javascript code related stuff of the jQuery enviroment.

Returns:
string

Definition at line 728 of file Container.php.

_renderScriptTags (  ) [protected]

Renders all javascript file related stuff of the jQuery enviroment.

Returns:
string

Definition at line 696 of file Container.php.

_renderStylesheets (  ) [protected]

Render jQuery stylesheets

Returns:
string

Definition at line 661 of file Container.php.

addJavascript ( js )

Add arbitrary javascript to execute in jQuery JS container

Parameters:
string$js
Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 522 of file Container.php.

addJavascriptFile ( path )

Add a Javascript File to the include stack.

Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 483 of file Container.php.

addOnLoad ( callback )

Add a script to execute onLoad

Parameters:
string$callbackLambda
Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 581 of file Container.php.

addStylesheet ( path )

Add a stylesheet

Parameters:
string$path
Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 556 of file Container.php.

clearJavascript (  )

Clear arbitrary javascript stack

Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 544 of file Container.php.

clearJavascriptFiles (  )

Clear all currently registered Javascript files.

Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 510 of file Container.php.

clearOnLoadActions (  )

Clear the onLoadActions stack.

Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 605 of file Container.php.

disable (  )

Disable jQuery

Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 172 of file Container.php.

enable (  )

Enable jQuery

Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 161 of file Container.php.

getCdnVersion (  )

Get CDN version

Deprecated:
As of version 1.8, use getVersion() instead.
Returns:
string

Definition at line 230 of file Container.php.

getJavascript (  )

Return all registered javascript statements

Returns:
array

Definition at line 534 of file Container.php.

getJavascriptFiles (  )

Return all currently registered Javascript files.

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

Returns:
Array

Definition at line 500 of file Container.php.

getLocalPath (  )

Get local path to jQuery

Returns:
string

Definition at line 403 of file Container.php.

getOnLoadActions (  )

Retrieve all registered onLoad actions

Returns:
array

Definition at line 595 of file Container.php.

getRenderMode (  )

Return bitmask of the current Render Mode

Returns:
integer

Definition at line 632 of file Container.php.

getStylesheets (  )

Retrieve registered stylesheets

Returns:
array

Definition at line 570 of file Container.php.

getUiCdnVersion (  )

Return jQuery UI CDN Version

Deprecated:
As of 1.8 use getUiVersion()
Returns:
String

Definition at line 341 of file Container.php.

getUiLocalPath (  )

Proxies to getUiPath() for consistency in function naming.

Returns:
string

Definition at line 373 of file Container.php.

getUiPath (  )

Return the local jQuery UI Path if set.

Returns:
string

Definition at line 363 of file Container.php.

getUiVersion (  )

Get jQuery UI Version used.

Returns:
string

Definition at line 318 of file Container.php.

getVersion (  )

Get the version used with the jQuery library

Returns:
string

Definition at line 206 of file Container.php.

isEnabled (  )

Is jQuery enabled?

Returns:
boolean

Definition at line 184 of file Container.php.

javascriptCaptureEnd (  )

Finish capturing arbitrary javascript to include in jQuery script

Returns:
boolean

Definition at line 469 of file Container.php.

javascriptCaptureStart (  )

Capture arbitrary javascript to include in jQuery script

Returns:
boolean

Definition at line 453 of file Container.php.

onLoadCaptureEnd (  )

Stop capturing routines to run onLoad

Returns:
boolean

Definition at line 439 of file Container.php.

onLoadCaptureStart (  )

Start capturing routines to run onLoad

Returns:
boolean

Definition at line 423 of file Container.php.

setCdnSsl ( flag )

Set Use SSL on CDN Flag

Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 240 of file Container.php.

setCdnVersion ( version = null )

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

Deprecated:
As of version 1.8, use setVersion() instead.
Parameters:
string$version
Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 219 of file Container.php.

setLocalPath ( path )

Set path to local jQuery library

Parameters:
string$path
Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 262 of file Container.php.

setRenderMode ( mask )

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.

See also:
ZendX_JQuery::RENDER_ALL
Parameters:
integer$mask
Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 622 of file Container.php.

setUiCdnVersion ( version = "1.5.2" )

Set jQuery UI CDN Version

Deprecated:
As of 1.8 use setUiVersion()
Parameters:
String$version
Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 330 of file Container.php.

setUiLocalPath ( path )

Set local path to jQuery UI library

Parameters:
String$path
Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 352 of file Container.php.

setUiVersion ( version )

Set jQuery UI version used.

Parameters:
string$version
Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 307 of file Container.php.

setVersion ( version )

Set the version of the jQuery library used.

Parameters:
string$version
Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 195 of file Container.php.

setView ( Zend_View_Interface view )

Set view object

Parameters:
Zend_View_Interface$view
Returns:
void

Definition at line 151 of file Container.php.

uiDisable (  )

Disable jQuery UI Library Rendering

Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 285 of file Container.php.

uiEnable (  )

Enable jQuery UI Library Rendering

Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 273 of file Container.php.

uiIsEnabled (  )

Check wheater currently the jQuery UI library is enabled.

Returns:
boolean

Definition at line 296 of file Container.php.

useCdn (  )

Are we using the CDN?

Returns:
boolean

Definition at line 251 of file Container.php.

useLocalPath (  )

Are we using a local path?

Returns:
boolean

Definition at line 413 of file Container.php.

useUiCdn (  )

Is the jQuery Ui enabled and loaded from CDN?

Returns:
ZendX_JQuery_View_Helper_JQuery_Container

Definition at line 393 of file Container.php.

useUiLocal (  )

Is the jQuery Ui loaded from local scope?

Returns:
boolean

Definition at line 383 of file Container.php.


The documentation for this class was generated from the following file: