Class ZendX_JQuery_View_Helper_JQuery_Container

Description

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

Located in /JQuery/View/Helper/JQuery/Container.php (line 32)


	
			
Variable Summary
 Zend_View_Interface $view
 Boolean $_captureLock
 Boolean $_enabled
 Boolean $_isXhtml
 Integer $_renderMode
 Boolean $_uiEnabled
 String $_uiPath
 String $_uiVersion
 String $_version
Method Summary
 string getCdnVersion ()
 array getJavascript ()
 string getLocalPath ()
 array getOnLoadActions ()
 integer getRenderMode ()
 array getStylesheets ()
 String getUiCdnVersion ()
 string getUiLocalPath ()
 string getUiPath ()
 boolean isEnabled ()
 boolean onLoadCaptureEnd ()
 boolean onLoadCaptureStart ()
 void setView ( $view)
 boolean uiIsEnabled ()
 boolean useCdn ()
 boolean useLocalPath ()
 boolean useUiLocal ()
 string _renderExtras ()
 string _renderScriptTags ()
 string _renderStylesheets ()
 string __toString ()
Variables
Zend_View_Interface $view = null (line 131)

View Instance

  • access: public
Boolean $_captureLock = false (line 60)

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

  • access: protected
Boolean $_enabled = false (line 53)

Indicates wheater the jQuery View Helper is enabled.

  • access: protected
Boolean $_isXhtml = false (line 88)

View is rendered in XHTML or not.

  • access: protected
Array $_javascriptSources = array() (line 46)

Additional javascript files that for jQuery Helper components.

  • access: protected
Array $_javascriptStatements = array() (line 67)

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

  • access: protected
String $_jqueryLibraryPath = null (line 39)

Path to local webserver jQuery library

  • access: protected
Array $_onLoadActions = array() (line 81)

jQuery onLoad statements Stack

  • access: protected
Integer $_renderMode = ZendX_JQuery::RENDER_ALL (line 102)

Default Render Mode (all parts)

  • access: protected
Array $_stylesheets = array() (line 74)

Additional stylesheet files for jQuery related components.

  • access: protected
Boolean $_uiEnabled = false (line 109)

jQuery UI Library Enabled

  • access: protected
String $_uiPath = null (line 117)

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

  • access: protected
String $_uiVersion = "1.5.2" (line 124)

jQuery UI Google CDN Version

  • access: protected
String $_version = "1.2.6" (line 95)

Default CDN jQuery Library version

  • access: protected
Methods
addJavascript (line 468)

Add arbitrary javascript to execute in jQuery JS container

  • access: public
ZendX_JQuery_View_Helper_JQuery_Container addJavascript (string $js)
  • string $js
addJavascriptFile (line 429)

Add a Javascript File to the include stack.

  • access: public
ZendX_JQuery_View_Helper_JQuery_Container addJavascriptFile ( $path)
  • $path
addOnLoad (line 535)

Add a script to execute onLoad

  • access: public
ZendX_JQuery_View_Helper_JQuery_Container addOnLoad (string $callback)
  • string $callback: Lambda
addStylesheet (line 510)

Add a stylesheet

  • access: public
ZendX_JQuery_View_Helper_JQuery_Container addStylesheet (string $path)
  • string $path
clearJavascript (line 498)

Clear arbitrary javascript stack

  • access: public
clearJavascriptFiles (line 456)

Clear all currently registered Javascript files.

  • access: public
disable (line 160)

Disable jQuery

  • access: public
enable (line 149)

Enable jQuery

  • access: public
getCdnVersion (line 198)

Get CDN version

  • access: public
string getCdnVersion ()
getJavascript (line 488)

Return all registered javascript statements

  • access: public
array getJavascript ()
getJavascriptFiles (line 446)

Return all currently registered Javascript files.

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

  • access: public
Array getJavascriptFiles ()
getLocalPath (line 349)

Get local path to jQuery

  • access: public
string getLocalPath ()
getOnLoadActions (line 548)

Retrieve all registered onLoad actions

  • access: public
array getOnLoadActions ()
getRenderMode (line 574)

Return bitmask of the current Render Mode

  • access: public
integer getRenderMode ()
getStylesheets (line 524)

Retrieve registered stylesheets

  • access: public
array getStylesheets ()
getUiCdnVersion (line 280)

Return jQuery UI CDN Version

  • access: public
String getUiCdnVersion ()
getUiLocalPath (line 313)

Proxies to getUiPath() for consistency in function naming.

  • access: public
string getUiLocalPath ()
getUiPath (line 303)

Return the local jQuery UI Path if set.

  • access: public
string getUiPath ()
isEnabled (line 172)

Is jQuery enabled?

  • access: public
boolean isEnabled ()
javascriptCaptureEnd (line 415)

Finish capturing arbitrary javascript to include in jQuery script

  • access: public
boolean javascriptCaptureEnd ()
javascriptCaptureStart (line 399)

Capture arbitrary javascript to include in jQuery script

  • access: public
boolean javascriptCaptureStart ()
onLoadCaptureEnd (line 385)

Stop capturing routines to run onLoad

  • access: public
boolean onLoadCaptureEnd ()
onLoadCaptureStart (line 369)

Start capturing routines to run onLoad

  • access: public
boolean onLoadCaptureStart ()
setCdnVersion (line 184)

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

  • access: public
ZendX_JQuery_View_Helper_JQuery_Container setCdnVersion ([string $version = null])
  • string $version
setLocalPath (line 219)

Set path to local jQuery library

  • access: public
ZendX_JQuery_View_Helper_JQuery_Container setLocalPath (string $path)
  • string $path
setRenderMode (line 564)

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.

ZendX_JQuery_View_Helper_JQuery_Container setRenderMode (integer $mask)
  • integer $mask
setUiCdnVersion (line 265)

Set jQuery UI CDN Version

  • access: public
ZendX_JQuery_View_Helper_JQuery_Container setUiCdnVersion ([String $version = "1.5.2"])
  • String $version
setUiLocalPath (line 291)

Set local path to jQuery UI library

  • access: public
ZendX_JQuery_View_Helper_JQuery_Container setUiLocalPath (String $path)
  • String $path
setView (line 139)

Set view object

  • access: public
void setView ( $view)
  • Zend_View_Interface $view
uiDisable (line 243)

Disable jQuery UI Library Rendering

  • access: public
uiEnable (line 231)

Enable jQuery UI Library Rendering

  • access: public
uiIsEnabled (line 254)

Check wheater currently the jQuery UI library is enabled.

  • access: public
boolean uiIsEnabled ()
useCdn (line 208)

Are we using the CDN?

  • access: public
boolean useCdn ()
useLocalPath (line 359)

Are we using a local path?

  • access: public
boolean useLocalPath ()
useUiCdn (line 336)

Is the jQuery Ui enabled and loaded from CDN?

  • access: public
useUiLocal (line 323)

Is the jQuery Ui enabled and loaded from local scope?

  • access: public
boolean useUiLocal ()
_getJQueryLibraryPath (line 729)

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

  • access: protected
string _getJQueryLibraryPath ()
_renderExtras (line 681)

Renders all javascript code related stuff of the jQuery enviroment.

  • access: protected
string _renderExtras ()
_renderScriptTags (line 645)

Renders all javascript file related stuff of the jQuery enviroment.

  • access: protected
string _renderScriptTags ()
_renderStylesheets (line 603)

Render jQuery stylesheets

  • access: protected
string _renderStylesheets ()
__toString (line 584)

String representation of jQuery environment

  • access: public
string __toString ()

Documentation generated on Fri, 27 Feb 2009 15:29:04 +0300 by phpDocumentor 1.4.2