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.
jQuery View Helper. Transports all jQuery stack and render information across all views.

Boolean
$_captureLock= 'false'
Indicates if a capture start method for javascript or onLoad has been called.
false
Details
Boolean
$_enabled= 'false'
Indicates wheater the jQuery View Helper is enabled.
false
Details
Array
$_javascriptSources= 'array()'
Additional javascript files that for jQuery Helper components.
array()
Details
Array
$_javascriptStatements= 'array()'
Additional javascript statements that need to be executed after jQuery lib.
array()
Details
String
$_jqueryLibraryPath= 'null'
Path to local webserver jQuery library
null
Details
boolean
$_loadSslCdnPath= 'false'
Load CDN Path from SSL or Non-SSL?
false
Details
Array
$_onLoadActions= 'array()'
jQuery onLoad statements Stack
array()
Details
Integer
$_renderMode= 'ZendX_JQuery::RENDER_ALL'
Default Render Mode (all parts)
ZendX_JQuery::RENDER_ALL
Details
Array
$_stylesheets= 'array()'
Additional stylesheet files for jQuery related components.
array()
Details
String
$_uiPath= 'null'
Local jQuery UI Path. Use Google CDN if variable is null
null
Details
String
$_uiVersion= 'ZendX_JQuery::DEFAULT_UI_VERSION'
jQuery UI Google CDN Version
ZendX_JQuery::DEFAULT_UI_VERSION
Details
String
$_version= 'ZendX_JQuery::DEFAULT_JQUERY_VERSION'
Default CDN jQuery Library version
ZendX_JQuery::DEFAULT_JQUERY_VERSION
Details
_getJQueryLibraryPath(
)
:
string
Internal function that constructs the include path of the jQuery library.
Type | Description |
---|---|
string |

_renderExtras(
)
:
string
Renders all javascript code related stuff of the jQuery enviroment.
Type | Description |
---|---|
string |

_renderScriptTags(
)
:
string
Renders all javascript file related stuff of the jQuery enviroment.
Type | Description |
---|---|
string |

addJavascript(
string $js
)
:
\ZendX_JQuery_View_Helper_JQuery_Container
Add arbitrary javascript to execute in jQuery JS container
Name | Type | Description |
---|---|---|
$js | string |
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

addJavascriptFile(
$path
)
:
\ZendX_JQuery_View_Helper_JQuery_Container
Add a Javascript File to the include stack.
Name | Type | Description |
---|---|---|
$path |
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

addOnLoad(
string $callback
)
:
\ZendX_JQuery_View_Helper_JQuery_Container
Add a script to execute onLoad
Name | Type | Description |
---|---|---|
$callback | string | Lambda |
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

addStylesheet(
string $path
)
:
\ZendX_JQuery_View_Helper_JQuery_Container
Add a stylesheet
Name | Type | Description |
---|---|---|
$path | string |
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

clearJavascript(
)
:
\ZendX_JQuery_View_Helper_JQuery_Container
Clear arbitrary javascript stack
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

clearJavascriptFiles(
)
:
\ZendX_JQuery_View_Helper_JQuery_Container
Clear all currently registered Javascript files.
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

clearOnLoadActions(
)
:
\ZendX_JQuery_View_Helper_JQuery_Container
Clear the onLoadActions stack.
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

disable(
)
:
\ZendX_JQuery_View_Helper_JQuery_Container
Disable jQuery
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

enable(
)
:
\ZendX_JQuery_View_Helper_JQuery_Container
Enable jQuery
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

getCdnSsl(
)
:
boolean
Get Flag of SSL on CDN
Type | Description |
---|---|
boolean | True if SSL is used on CDN |

getCdnVersion(
)
:
string
Get CDN version
Type | Description |
---|---|
string |

getJavascriptFiles(
)
:
Array
Return all currently registered Javascript files.
This does not include the jQuery library, which is handled by another retrieval strategy.
Type | Description |
---|---|
Array |

getRenderMode(
)
:
integer
Return bitmask of the current Render Mode
Type | Description |
---|---|
integer |

getUiCdnVersion(
)
:
String
Return jQuery UI CDN Version
Type | Description |
---|---|
String |

getUiLocalPath(
)
:
string
Proxies to getUiPath() for consistency in function naming.
Type | Description |
---|---|
string |

javascriptCaptureEnd(
)
:
boolean
Finish capturing arbitrary javascript to include in jQuery script
Type | Description |
---|---|
boolean |

javascriptCaptureStart(
)
:
boolean
Capture arbitrary javascript to include in jQuery script
Type | Description |
---|---|
boolean |

onLoadCaptureStart(
)
:
boolean
Start capturing routines to run onLoad
Type | Description |
---|---|
boolean |

setCdnSsl(
$flag
)
:
\ZendX_JQuery_View_Helper_JQuery_Container
Set Use SSL on CDN Flag
Name | Type | Description |
---|---|---|
$flag |
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

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
Name | Type | Description |
---|---|---|
$version | string |
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

setLocalPath(
string $path
)
:
\ZendX_JQuery_View_Helper_JQuery_Container
Set path to local jQuery library
Name | Type | Description |
---|---|---|
$path | string |
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

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.
Name | Type | Description |
---|---|---|
$mask | integer |
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

setUiCdnVersion(
String $version
=
"1.5.2"
)
:
\ZendX_JQuery_View_Helper_JQuery_Container
Set jQuery UI CDN Version
Name | Type | Description |
---|---|---|
$version | String |
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

setUiLocalPath(
String $path
)
:
\ZendX_JQuery_View_Helper_JQuery_Container
Set local path to jQuery UI library
Name | Type | Description |
---|---|---|
$path | String |
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

setUiVersion(
string $version
)
:
\ZendX_JQuery_View_Helper_JQuery_Container
Set jQuery UI version used.
Name | Type | Description |
---|---|---|
$version | string |
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

setVersion(
string $version
)
:
\ZendX_JQuery_View_Helper_JQuery_Container
Set the version of the jQuery library used.
Name | Type | Description |
---|---|---|
$version | string |
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

setView(
\Zend_View_Interface $view
)
:
void
Set view object
Name | Type | Description |
---|---|---|
$view | \Zend_View_Interface |

uiDisable(
)
:
\ZendX_JQuery_View_Helper_JQuery_Container
Disable jQuery UI Library Rendering
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

uiEnable(
)
:
\ZendX_JQuery_View_Helper_JQuery_Container
Enable jQuery UI Library Rendering
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |

uiIsEnabled(
)
:
boolean
Check wheater currently the jQuery UI library is enabled.
Type | Description |
---|---|
boolean |

useUiCdn(
)
:
\ZendX_JQuery_View_Helper_JQuery_Container
Is the jQuery Ui enabled and loaded from CDN?
Type | Description |
---|---|
\ZendX_JQuery_View_Helper_JQuery_Container |