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.
falseDetails
Boolean
$_enabled= 'false'
Indicates wheater the jQuery View Helper is enabled.
falseDetails
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
nullDetails
boolean
$_loadSslCdnPath= 'false'
Load CDN Path from SSL or Non-SSL?
falseDetails
Array
$_onLoadActions= 'array()'
jQuery onLoad statements Stack
array()Details
Integer
$_renderMode= 'ZendX_JQuery::RENDER_ALL'
Default Render Mode (all parts)
ZendX_JQuery::RENDER_ALLDetails
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
nullDetails
String
$_uiVersion= 'ZendX_JQuery::DEFAULT_UI_VERSION'
jQuery UI Google CDN Version
ZendX_JQuery::DEFAULT_UI_VERSIONDetails
String
$_version= 'ZendX_JQuery::DEFAULT_JQUERY_VERSION'
Default CDN jQuery Library version
ZendX_JQuery::DEFAULT_JQUERY_VERSIONDetails
_getJQueryLibraryPath(
)
:
stringInternal function that constructs the include path of the jQuery library.
| Type | Description |
|---|---|
| string |

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

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

addJavascript(
string $js
)
:
\ZendX_JQuery_View_Helper_JQuery_ContainerAdd 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_ContainerAdd 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_ContainerAdd 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_ContainerAdd a stylesheet
| Name | Type | Description |
|---|---|---|
| $path | string |
| Type | Description |
|---|---|
| \ZendX_JQuery_View_Helper_JQuery_Container |

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

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

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

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

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

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

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

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

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

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

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

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

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

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

setCdnSsl(
$flag
)
:
\ZendX_JQuery_View_Helper_JQuery_ContainerSet 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_ContainerUse 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_ContainerSet 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_ContainerSet 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_ContainerSet 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_ContainerSet 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_ContainerSet 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_ContainerSet 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
)
:
voidSet view object
| Name | Type | Description |
|---|---|---|
| $view | \Zend_View_Interface |

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

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

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

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