ZendX/JQuery/View/Helper/JQuery/Container.php
Properties
category
copyright
license
package
subpackage
version
Description 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.
Includes ZendX/JQuery.php
(Require Once) Classes
ZendX_JQuery_View_Helper_JQuery_Container
Properties
Extends
Implements
copyright
license
package
subpackage
uses
Abstract No
Final No
Description
jQuery View Helper. Transports all jQuery stack and render information across all views.
Methods
__toString ,
_getJQueryLibraryBaseCdnUri ,
_getJQueryLibraryPath ,
_getJQueryUiLibraryBaseCdnUri ,
_getJQueryUiLibraryPath ,
_renderExtras ,
_renderScriptTags ,
_renderStylesheets ,
addJavascript ,
addJavascriptFile ,
addOnLoad ,
addStylesheet ,
clearJavascript ,
clearJavascriptFiles ,
clearOnLoadActions ,
disable ,
enable ,
getCdnVersion ,
getJavascript ,
getJavascriptFiles ,
getLocalPath ,
getOnLoadActions ,
getRenderMode ,
getStylesheets ,
getUiCdnVersion ,
getUiLocalPath ,
getUiPath ,
getUiVersion ,
getVersion ,
isEnabled ,
javascriptCaptureEnd ,
javascriptCaptureStart ,
onLoadCaptureEnd ,
onLoadCaptureStart ,
setCdnSsl ,
setCdnVersion ,
setLocalPath ,
setRenderMode ,
setUiCdnVersion ,
setUiLocalPath ,
setUiVersion ,
setVersion ,
setView ,
uiDisable ,
uiEnable ,
uiIsEnabled ,
useCdn ,
useLocalPath ,
useUiCdn ,
useUiLocal ,
__toString(
)
:
string
Description
String representation of jQuery environment
Return value
_getJQueryLibraryBaseCdnUri(
)
:
string
Description
Return value
_getJQueryLibraryPath(
)
:
string
Description
Internal function that constructs the include path of the jQuery library.
Return value
_getJQueryUiLibraryBaseCdnUri(
)
:
string
Description
Return value
_getJQueryUiLibraryPath(
)
:
string
Description
Return value
_renderExtras(
)
:
string
Description
Renders all javascript code related stuff of the jQuery enviroment.
Return value
_renderScriptTags(
)
:
string
Description
Renders all javascript file related stuff of the jQuery enviroment.
Return value
_renderStylesheets(
)
:
string
Description
Render jQuery stylesheets
Return value
Description
Add arbitrary javascript to execute in jQuery JS container
Arguments
Name
Type
Description
Default
$js
string |
Return value
Description
Add a Javascript File to the include stack.
Arguments
Name
Type
Description
Default
$path
n/a
Return value
Description
Add a script to execute onLoad
Arguments
Name
Type
Description
Default
$callback
string |
Lambda
Return value
Description
Add a stylesheet
Arguments
Name
Type
Description
Default
$path
string |
Return value
Description
Clear arbitrary javascript stack
Return value
Description
Clear all currently registered Javascript files.
Return value
Description
Clear the onLoadActions stack.
Return value
Description
Disable jQuery
Return value
Description
Enable jQuery
Return value
getCdnVersion(
)
:
string
Description
Get CDN version
Return value
Tags
Name
Description
deprecated
As of version 1.8, use {@link getVersion()} instead.
getJavascript(
)
:
array
Description
Return all registered javascript statements
Return value
getJavascriptFiles(
)
:
Array
Description
Return all currently registered Javascript files. This does not include the jQuery library, which is handled by another retrieval
strategy.
Return value
getLocalPath(
)
:
string
Description
Get local path to jQuery
Return value
getOnLoadActions(
)
:
array
Description
Retrieve all registered onLoad actions
Return value
getRenderMode(
)
:
integer
Description
Return bitmask of the current Render Mode
Return value
getStylesheets(
)
:
array
Description
Retrieve registered stylesheets
Return value
getUiCdnVersion(
)
:
String
Description
Return jQuery UI CDN Version
Return value
Tags
Name
Description
deprecated
As of 1.8 use {@link getUiVersion()}
getUiLocalPath(
)
:
string
Description
Proxies to getUiPath() for consistency in function naming.
Return value
getUiPath(
)
:
string
Description
Return the local jQuery UI Path if set.
Return value
getUiVersion(
)
:
string
Description
Get jQuery UI Version used.
Return value
getVersion(
)
:
string
Description
Get the version used with the jQuery library
Return value
isEnabled(
)
:
boolean
Description
Is jQuery enabled?
Return value
javascriptCaptureEnd(
)
:
boolean
Description
Finish capturing arbitrary javascript to include in jQuery script
Return value
javascriptCaptureStart(
)
:
boolean
Description
Capture arbitrary javascript to include in jQuery script
Return value
onLoadCaptureEnd(
)
:
boolean
Description
Stop capturing routines to run onLoad
Return value
onLoadCaptureStart(
)
:
boolean
Description
Start capturing routines to run onLoad
Return value
Description
Set Use SSL on CDN Flag
Arguments
Name
Type
Description
Default
$flag
n/a
Return value
Description
Use CDN, using version specified. Currently supported
by Googles Ajax Library API are: 1.2.3, 1.2.6
Arguments
Name
Type
Description
Default
$version
string |
null
Return value
Tags
Name
Description
deprecated
As of version 1.8, use {@link setVersion()} instead.
Description
Set path to local jQuery library
Arguments
Name
Type
Description
Default
$path
string |
Return value
Description
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.
Arguments
Name
Type
Description
Default
$mask
integer |
Return value
Tags
Name
Description
see
ZendX_JQuery::RENDER_ALL
Description
Set jQuery UI CDN Version
Arguments
Name
Type
Description
Default
$version
String |
1.5.2
Return value
Tags
Name
Description
deprecated
As of 1.8 use {@link setUiVersion()}
Description
Set local path to jQuery UI library
Arguments
Name
Type
Description
Default
$path
String |
Return value
Description
Set jQuery UI version used.
Arguments
Name
Type
Description
Default
$version
string |
Return value
Description
Set the version of the jQuery library used.
Arguments
Name
Type
Description
Default
$version
string |
Return value
setView(
Zend_View_Interface
$view,
)
:
void
Description
Set view object
Arguments
Name
Type
Description
Default
$view
Zend_View_Interface |
Return value
Description
Disable jQuery UI Library Rendering
Return value
Description
Enable jQuery UI Library Rendering
Return value
uiIsEnabled(
)
:
boolean
Description
Check wheater currently the jQuery UI library is enabled.
Return value
useCdn(
)
:
boolean
Description
Are we using the CDN?
Return value
useLocalPath(
)
:
boolean
Description
Are we using a local path?
Return value
Description
Is the jQuery Ui enabled and loaded from CDN?
Return value
useUiLocal(
)
:
boolean
Description
Is the jQuery Ui loaded from local scope?
Return value
Properties
$_captureLock ,
$_enabled ,
$_isXhtml ,
$_javascriptSources ,
$_javascriptStatements ,
$_jqueryLibraryPath ,
$_loadSslCdnPath ,
$_onLoadActions ,
$_renderMode ,
$_stylesheets ,
$_uiEnabled ,
$_uiPath ,
$_uiVersion ,
$_version ,
$view ,
protected
$_captureLock
=
false
Indicates if a capture start method for javascript or onLoad has been called.Boolean
protected
$_enabled
=
false
Indicates wheater the jQuery View Helper is enabled.Boolean
protected
$_isXhtml
=
false
View is rendered in XHTML or not.Boolean
protected
$_javascriptSources
=
array
Additional javascript files that for jQuery Helper components.Array
protected
$_javascriptStatements
=
array
Additional javascript statements that need to be executed after jQuery lib.Array
protected
$_jqueryLibraryPath
=
null
Path to local webserver jQuery libraryString
protected
$_loadSslCdnPath
=
false
Load CDN Path from SSL or Non-SSL?boolean
protected
$_onLoadActions
=
array
jQuery onLoad statements StackArray
protected
$_renderMode
=
ZendX_JQuery
Default Render Mode (all parts)Integer
protected
$_stylesheets
=
array
Additional stylesheet files for jQuery related components.Array
protected
$_uiEnabled
=
false
jQuery UI Library EnabledBoolean
protected
$_uiPath
=
null
Local jQuery UI Path. Use Google CDN if
variable is nullString
protected
$_uiVersion
=
ZendX_JQuery
jQuery UI Google CDN VersionString
protected
$_version
=
ZendX_JQuery
Default CDN jQuery Library versionString
public
$view
=
null
View InstanceZend_View_Interface