## ZendX_JQuery_View_Helper_JQuery_Container

Description

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

- copyright: Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
- usedby: ZendX_JQuery_View_Helper_UiWidgetPane
- usedby: ZendX_JQuery_View_Helper_UiWidget
- license: New BSD License
- uses: ZendX_JQuery_View_Helper_JQuery_Container
- usedby: ZendX_JQuery_View_Helper_JQuery_Container

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

Variable Summary
Zend_View_Interface $view
Boolean $_captureLock
Boolean $_enabled
Boolean $_isXhtml
Array $_javascriptSources
Array $_javascriptStatements
String $_jqueryLibraryPath
boolean $_loadSslCdnPath
Array $_onLoadActions
Integer $_renderMode
Array $_stylesheets
Boolean $_uiEnabled
String $_uiPath
String $_uiVersion
String $_version
Method Summary
ZendX_JQuery_View_Helper_JQuery_Container addJavascript (string $js)
ZendX_JQuery_View_Helper_JQuery_Container addJavascriptFile ( $path)
ZendX_JQuery_View_Helper_JQuery_Container addOnLoad (string $callback)
ZendX_JQuery_View_Helper_JQuery_Container addStylesheet (string $path)
ZendX_JQuery_View_Helper_JQuery_Container clearJavascript ()
ZendX_JQuery_View_Helper_JQuery_Container clearJavascriptFiles ()
ZendX_JQuery_View_Helper_JQuery_Container clearOnLoadActions ()
ZendX_JQuery_View_Helper_JQuery_Container disable ()
ZendX_JQuery_View_Helper_JQuery_Container enable ()
string getCdnVersion ()
array getJavascript ()
Array getJavascriptFiles ()
string getLocalPath ()
array getOnLoadActions ()
integer getRenderMode ()
array getStylesheets ()
String getUiCdnVersion ()
string getUiLocalPath ()
string getUiPath ()
string getUiVersion ()
string getVersion ()
boolean isEnabled ()
boolean javascriptCaptureEnd ()
boolean javascriptCaptureStart ()
boolean onLoadCaptureEnd ()
boolean onLoadCaptureStart ()
ZendX_JQuery_View_Helper_JQuery_Container setCdnSsl ( $flag)
ZendX_JQuery_View_Helper_JQuery_Container setCdnVersion ([string $version = null])
ZendX_JQuery_View_Helper_JQuery_Container setLocalPath (string $path)
ZendX_JQuery_View_Helper_JQuery_Container setRenderMode (integer $mask)
ZendX_JQuery_View_Helper_JQuery_Container setUiCdnVersion ([String $version = "1.5.2"])
ZendX_JQuery_View_Helper_JQuery_Container setUiLocalPath (String $path)
ZendX_JQuery_View_Helper_JQuery_Container setUiVersion (string $version)
ZendX_JQuery_View_Helper_JQuery_Container setVersion (string $version)
void setView ( $view)
ZendX_JQuery_View_Helper_JQuery_Container uiDisable ()
ZendX_JQuery_View_Helper_JQuery_Container uiEnable ()
boolean uiIsEnabled ()
boolean useCdn ()
boolean useLocalPath ()
ZendX_JQuery_View_Helper_JQuery_Container useUiCdn ()
boolean useUiLocal ()
string _getJQueryLibraryBaseCdnUri ()
string _getJQueryLibraryPath ()
string _getJQueryUiLibraryBaseCdnUri ()
string _getJQueryUiLibraryPath ()
string _renderExtras ()
string _renderScriptTags ()
string _renderStylesheets ()
string __toString ()
Variables
Zend_View_Interface $view = null (line 143)

View Instance

- access: public

Boolean $_captureLock = false (line 65)

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

- access: protected

Boolean $_enabled = false (line 58)

Indicates wheater the jQuery View Helper is enabled.

- access: protected

Boolean $_isXhtml = false (line 93)

View is rendered in XHTML or not.

- access: protected

Array $_javascriptSources = array() (line 51)

Additional javascript files that for jQuery Helper components.

- access: protected

Array $_javascriptStatements = array() (line 72)

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

- access: protected

String $_jqueryLibraryPath = null (line 44)

Path to local webserver jQuery library

- access: protected

boolean $_loadSslCdnPath = false (line 136)

Load CDN Path from SSL or Non-SSL?

- access: protected

Array $_onLoadActions = array() (line 86)

jQuery onLoad statements Stack

- access: protected

Integer $_renderMode = ZendX_JQuery::RENDER_ALL (line 107)

Default Render Mode (all parts)

- access: protected

Array $_stylesheets = array() (line 79)

Additional stylesheet files for jQuery related components.

- access: protected

Boolean $_uiEnabled = false (line 114)

jQuery UI Library Enabled

- access: protected

String $_uiPath = null (line 122)

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

- access: protected

String $_uiVersion = ZendX_JQuery::DEFAULT_UI_VERSION (line 129)

jQuery UI Google CDN Version

- access: protected

String $_version = ZendX_JQuery::DEFAULT_JQUERY_VERSION (line 100)

Default CDN jQuery Library version

- access: protected

Methods
addJavascript (line 526)

Add arbitrary javascript to execute in jQuery JS container

- access: public

ZendX_JQuery_View_Helper_JQuery_Container addJavascript (string $js)

- string $js

addJavascriptFile (line 487)

Add a Javascript File to the include stack.

- access: public

ZendX_JQuery_View_Helper_JQuery_Container addJavascriptFile ( $path)

- $path

addOnLoad (line 593)

Add a script to execute onLoad

- access: public

ZendX_JQuery_View_Helper_JQuery_Container addOnLoad (string $callback)

- string $callback: Lambda

addStylesheet (line 568)

Add a stylesheet

- access: public

ZendX_JQuery_View_Helper_JQuery_Container addStylesheet (string $path)

- string $path

clearJavascript (line 556)

Clear arbitrary javascript stack

- access: public

ZendX_JQuery_View_Helper_JQuery_Container clearJavascript ()
clearJavascriptFiles (line 514)

Clear all currently registered Javascript files.

- access: public

ZendX_JQuery_View_Helper_JQuery_Container clearJavascriptFiles ()
clearOnLoadActions (line 616)

Clear the onLoadActions stack.

- access: public

ZendX_JQuery_View_Helper_JQuery_Container clearOnLoadActions ()
disable (line 172)

Disable jQuery

- access: public

ZendX_JQuery_View_Helper_JQuery_Container disable ()
enable (line 161)

Enable jQuery

- access: public

ZendX_JQuery_View_Helper_JQuery_Container enable ()
getCdnVersion (line 232)

Get CDN version

- deprecated: As of version 1.8, use getVersion() instead.
- access: public

string getCdnVersion ()
getJavascript (line 546)

Return all registered javascript statements

- access: public

array getJavascript ()
getJavascriptFiles (line 504)

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 407)

Get local path to jQuery

- access: public

string getLocalPath ()
getOnLoadActions (line 606)

Retrieve all registered onLoad actions

- access: public

array getOnLoadActions ()
getRenderMode (line 643)

Return bitmask of the current Render Mode

- access: public

integer getRenderMode ()
getStylesheets (line 582)

Retrieve registered stylesheets

- access: public

array getStylesheets ()
getUiCdnVersion (line 345)

Return jQuery UI CDN Version

- deprecated: As of 1.8 use getUiVersion()
- access: public

String getUiCdnVersion ()
getUiLocalPath (line 377)

Proxies to getUiPath() for consistency in function naming.

- access: public

string getUiLocalPath ()
getUiPath (line 367)

Return the local jQuery UI Path if set.

- access: public

string getUiPath ()
getUiVersion (line 322)

Get jQuery UI Version used.

- access: public

string getUiVersion ()
getVersion (line 208)

Get the version used with the jQuery library

- access: public

string getVersion ()
isEnabled (line 184)

Is jQuery enabled?

- access: public

boolean isEnabled ()
javascriptCaptureEnd (line 473)

Finish capturing arbitrary javascript to include in jQuery script

- access: public

boolean javascriptCaptureEnd ()
javascriptCaptureStart (line 457)

Capture arbitrary javascript to include in jQuery script

- access: public

boolean javascriptCaptureStart ()
onLoadCaptureEnd (line 443)

Stop capturing routines to run onLoad

- access: public

boolean onLoadCaptureEnd ()
onLoadCaptureStart (line 427)

Start capturing routines to run onLoad

- access: public

boolean onLoadCaptureStart ()
setCdnSsl (line 242)

Set Use SSL on CDN Flag

- access: public

ZendX_JQuery_View_Helper_JQuery_Container setCdnSsl ( $flag)

- $flag

setCdnVersion (line 221)

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.
- access: public

ZendX_JQuery_View_Helper_JQuery_Container setCdnVersion ([string $version = null])

- string $version

setLocalPath (line 264)

Set path to local jQuery library

- access: public

ZendX_JQuery_View_Helper_JQuery_Container setLocalPath (string $path)

- string $path

setRenderMode (line 633)

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: ZendX_JQuery::RENDER_ALL
- access: public

ZendX_JQuery_View_Helper_JQuery_Container setRenderMode (integer $mask)

- integer $mask

setUiCdnVersion (line 334)

Set jQuery UI CDN Version

- deprecated: As of 1.8 use setUiVersion()
- access: public

ZendX_JQuery_View_Helper_JQuery_Container setUiCdnVersion ([String $version = "1.5.2"])

- String $version

setUiLocalPath (line 356)

Set local path to jQuery UI library

- access: public

ZendX_JQuery_View_Helper_JQuery_Container setUiLocalPath (String $path)

- String $path

setUiVersion (line 309)

Set jQuery UI version used.

- access: public

ZendX_JQuery_View_Helper_JQuery_Container setUiVersion (string $version)

- string $version

setVersion (line 195)

Set the version of the jQuery library used.

- access: public

ZendX_JQuery_View_Helper_JQuery_Container setVersion (string $version)

- string $version

setView (line 151)

Set view object

- access: public

void setView ( $view)

- Zend_View_Interface $view

uiDisable (line 287)

Disable jQuery UI Library Rendering

- access: public

ZendX_JQuery_View_Helper_JQuery_Container uiDisable ()
uiEnable (line 275)

Enable jQuery UI Library Rendering

- access: public

ZendX_JQuery_View_Helper_JQuery_Container uiEnable ()
uiIsEnabled (line 298)

Check wheater currently the jQuery UI library is enabled.

- access: public

boolean uiIsEnabled ()
useCdn (line 253)

Are we using the CDN?

- access: public

boolean useCdn ()
useLocalPath (line 417)

Are we using a local path?

- access: public

boolean useLocalPath ()
useUiCdn (line 397)

Is the jQuery Ui enabled and loaded from CDN?

- access: public

ZendX_JQuery_View_Helper_JQuery_Container useUiCdn ()
useUiLocal (line 387)

Is the jQuery Ui loaded from local scope?

- access: public

boolean useUiLocal ()
_getJQueryLibraryBaseCdnUri (line 791)

- access: protected

string _getJQueryLibraryBaseCdnUri ()
_getJQueryLibraryPath (line 819)

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

- access: protected

string _getJQueryLibraryPath ()
_getJQueryUiLibraryBaseCdnUri (line 804)

- access: protected

string _getJQueryUiLibraryBaseCdnUri ()
_getJQueryUiLibraryPath (line 837)

- access: protected

string _getJQueryUiLibraryPath ()
_renderExtras (line 746)

Renders all javascript code related stuff of the jQuery enviroment.

- access: protected

string _renderExtras ()
_renderScriptTags (line 714)

Renders all javascript file related stuff of the jQuery enviroment.

- access: protected

string _renderScriptTags ()
_renderStylesheets (line 672)

Render jQuery stylesheets

- access: protected

string _renderStylesheets ()
__toString (line 653)

String representation of jQuery environment

- access: public

string __toString ()

Documentation generated on Mon, 24 Aug 2009 17:58:44 -0700 by phpDocumentor 1.4.2