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.
Boolean $_enabled = 'false'
Indicates wheater the jQuery View Helper is enabled.
Boolean $_isXhtml = 'false'
View is rendered in XHTML or not.
Array $_javascriptSources = 'array'
Additional javascript files that for jQuery Helper components.
Array $_javascriptStatements = 'array'
Additional javascript statements that need to be executed after jQuery lib.
String $_jqueryLibraryPath = 'null'
Path to local webserver jQuery library
boolean $_loadSslCdnPath = 'false'
Load CDN Path from SSL or Non-SSL?
Array $_onLoadActions = 'array'
jQuery onLoad statements Stack
Integer $_renderMode = 'ZendX_JQuery'
Default Render Mode (all parts)
Array $_stylesheets = 'array'
Additional stylesheet files for jQuery related components.
Boolean $_uiEnabled = 'false'
jQuery UI Library Enabled
String $_uiPath = 'null'
Local jQuery UI Path. Use Google CDN if variable is null
String $_uiVersion = 'ZendX_JQuery'
jQuery UI Google CDN Version
String $_version = 'ZendX_JQuery'
Default CDN jQuery Library version
Zend_View_Interface $view = 'null'
View Instance
__toString(
)
:
string
String representation of jQuery environment
_getJQueryLibraryBaseCdnUri(
)
:
string
_getJQueryLibraryPath(
)
:
string
Internal function that constructs the include path of the jQuery library.
_getJQueryUiLibraryBaseCdnUri(
)
:
string
_getJQueryUiLibraryPath(
)
:
string
_renderExtras(
)
:
string
Renders all javascript code related stuff of the jQuery enviroment.
_renderScriptTags(
)
:
string
Renders all javascript file related stuff of the jQuery enviroment.
_renderStylesheets(
)
:
string
Render jQuery stylesheets
addJavascript(
string $js
)
:
ZendX_JQuery_View_Helper_JQuery_Container
Add arbitrary javascript to execute in jQuery JS container
addJavascriptFile(
$path
)
:
ZendX_JQuery_View_Helper_JQuery_Container
Add a Javascript File to the include stack.
addOnLoad(
string $callback
)
:
ZendX_JQuery_View_Helper_JQuery_Container
Add a script to execute onLoad
addStylesheet(
string $path
)
:
ZendX_JQuery_View_Helper_JQuery_Container
Add a stylesheet
clearJavascript(
)
:
ZendX_JQuery_View_Helper_JQuery_Container
Clear arbitrary javascript stack
clearJavascriptFiles(
)
:
ZendX_JQuery_View_Helper_JQuery_Container
Clear all currently registered Javascript files.
clearOnLoadActions(
)
:
ZendX_JQuery_View_Helper_JQuery_Container
Clear the onLoadActions stack.
disable(
)
:
ZendX_JQuery_View_Helper_JQuery_Container
Disable jQuery
enable(
)
:
ZendX_JQuery_View_Helper_JQuery_Container
Enable jQuery
getCdnSsl(
)
:
boolean
Get Flag of SSL on CDN
getCdnVersion(
)
:
string
Get CDN version
getJavascript(
)
:
array
Return all registered javascript statements
getJavascriptFiles(
)
:
Array
Return all currently registered Javascript files.
This does not include the jQuery library, which is handled by another retrieval strategy.
getLocalPath(
)
:
string
Get local path to jQuery
getOnLoadActions(
)
:
array
Retrieve all registered onLoad actions
getRenderMode(
)
:
integer
Return bitmask of the current Render Mode
getStylesheets(
)
:
array
Retrieve registered stylesheets
getUiCdnVersion(
)
:
String
Return jQuery UI CDN Version
getUiLocalPath(
)
:
string
Proxies to getUiPath() for consistency in function naming.
getUiPath(
)
:
string
Return the local jQuery UI Path if set.
getUiVersion(
)
:
string
Get jQuery UI Version used.
getVersion(
)
:
string
Get the version used with the jQuery library
isEnabled(
)
:
boolean
Is jQuery enabled?
javascriptCaptureEnd(
)
:
boolean
Finish capturing arbitrary javascript to include in jQuery script
javascriptCaptureStart(
)
:
boolean
Capture arbitrary javascript to include in jQuery script
onLoadCaptureEnd(
)
:
boolean
Stop capturing routines to run onLoad
onLoadCaptureStart(
)
:
boolean
Start capturing routines to run onLoad
setCdnSsl(
$flag
)
:
ZendX_JQuery_View_Helper_JQuery_Container
Set Use SSL on CDN Flag
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
setLocalPath(
string $path
)
:
ZendX_JQuery_View_Helper_JQuery_Container
Set path to local jQuery library
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.
setUiCdnVersion(
String $version
=
1.5.2
)
:
ZendX_JQuery_View_Helper_JQuery_Container
Set jQuery UI CDN Version
setUiLocalPath(
String $path
)
:
ZendX_JQuery_View_Helper_JQuery_Container
Set local path to jQuery UI library
setUiVersion(
string $version
)
:
ZendX_JQuery_View_Helper_JQuery_Container
Set jQuery UI version used.
setVersion(
string $version
)
:
ZendX_JQuery_View_Helper_JQuery_Container
Set the version of the jQuery library used.
setView(
Zend_View_Interface $view
)
:
void
Set view object
uiDisable(
)
:
ZendX_JQuery_View_Helper_JQuery_Container
Disable jQuery UI Library Rendering
uiEnable(
)
:
ZendX_JQuery_View_Helper_JQuery_Container
Enable jQuery UI Library Rendering
uiIsEnabled(
)
:
boolean
Check wheater currently the jQuery UI library is enabled.
useCdn(
)
:
boolean
Are we using the CDN?
useLocalPath(
)
:
boolean
Are we using a local path?
useUiCdn(
)
:
ZendX_JQuery_View_Helper_JQuery_Container
Is the jQuery Ui enabled and loaded from CDN?
useUiLocal(
)
:
boolean
Is the jQuery Ui loaded from local scope?