Or using the ZendX_JQuery::enableView(Zend_View_Interface $view) method
that does the same for you.

jQuery() View Helper

The jQuery() view helper simplifies setup of your jQuery environment
in your application. It takes care of loading the core and ui library dependencies if necessary
and acts as a stack for all the registered onLoad javascript statements. All jQuery view helpers
put their javascript code onto this stack. It acts as a collector for everything jQuery in your
application with the following responsibilities:

Handling deployment of CDN or a local path jQuery Core
and UI libraries.

The jQuery() view helper implementation, like its dojo() pendant,
follows the placeholder architecture implementation; the data set in it persists between view
objects, and may be directly echo'd from your layout script. Since views specified in a Zend_Layout
script file are rendered before the layout itself, the jQuery() helper can act as a
stack for jQuery statements and render them into the head segment of the html page.

Contrary to Dojo, themes cannot be loaded from a CDN for the jQuery UI widgets and have to be implemented
in your pages stylesheet file or loaded from an extra stylesheet file. A default theme called Flora can be
obtained from the jQuery UI downloadable file.

Example #1 jQuery() View Helper Example

In this example a jQuery environment using the core and UI libraries will be needed. UI Widgets should
be rendered with the Flora thema that is installed in 'public/styles/flora.all.css'. The jQuery libraries
are both loaded from local paths.

To register the jQuery functionality inside the view object, you have to add the appropriate helpers
to the view helper path. There are many ways of accomplishing this, based on the requirements that the
jQuery helpers have. If you need them in one specific view only, you can use the addHelperPath method
on initialization of this view, or right before rendering:

Both helpers now stacked some javascript statements on the jQuery helper and printed a link and
a form element respectively. To access the javascript we have to utilize the jQuery()
functionality. Both helpers already activated their dependencies that is they have called
jQuery()->enable() and jQuery()->uiEnable(). We only have to print
the jQuery() environment, and we choose to do so in the layout script's head segment:

Although $this->layout()->content; is printed behind the $this->jQuery() statement,
the content of the view script is rendered before. This way all the javascript onLoad code has already been put
on the onLoad stack and can be printed within the head segment of the html document.

jQuery NoConflict Mode

jQuery offers a noConflict mode that allows the library to be run side by side with other javascript libraries
that operate in the global namespace, Prototype for example. The Zend Framework jQuery View Helper makes usage of
the noConflict mode very easy. If you want to run Prototype and jQuery side by side you can call
ZendX_JQuery_View_Helper_JQuery::enableNoConflictMode(); and all jQuery helpers will operate in the No Conflict
Mode.

Example #2 Building your own Helper with No Conflict Mode

To make use of the NoConflict Mode in your own jQuery helper, you only have to use the static method
ZendX_JQuery_View_Helper_JQuery::getJQueryHandler() method. It returns the variable jQuery is operating
in at the moment, either $ or $j

class MyHelper_SomeHelper extends Zend_View_Helper_Abstract

{

publicfunction someHelper()

{

$jquery = $this->view->jQuery();

$jquery->enable(); // enable jQuery Core Library

// get current jQuery handler based on noConflict settings

$jqHandler = ZendX_JQuery_View_Helper_JQuery::getJQueryHandler();

$function = '("#element").click(function() '

. '{ alert("noConflict Mode Save Helper!"); }'

. ')';

$jquery->addOnload($jqHandler . $function);

return'';

}

}

jQuery UI Themes

Since there are no online available themes to use out of the box, the implementation of the UI library themes
is a bit more complex than with the Dojo helper. The jQuery UI documentation describes for each component
what stylesheet information is needed and the Default and Flora Themes from the downloadable archive give hints
on the usage of stylesheets. The jQuery helper offers the function jQuery()->addStylesheet($path);
function to include the dependant stylesheets whenever the helper is enabled and rendered. You can optionally
merge the required stylesheet information in your main stylesheet file.

Methods Available

The jQuery() view helper always returns an instance of
the jQuery placeholder container. That container object has the
following methods available:

jQuery Core Library methods

enable(): explicitly enable jQuery
integration.

disable(): disable jQuery
integration.

isEnabled(): determine whether or not
jQuery integration is enabled.

setVersion(): set the jQuery version
that is used. This also decides on the library loaded
from the Google Ajax Library CDN

getVersion(): get the current jQuery
that is used. This also decides on the library loaded
from the Google Ajax Library CDN

useCdn(): Return true, if CDN usage is
currently enabled

useLocalPath(): Return true, if local usage
is currently enabled

setLocalPath(): Set the local path to the
jQuery Core library

getLocalPath(): If set, return the local path to the
jQuery Core library

jQuery UI Library methods

uiEnable(): explicitly enable jQuery UI
integration.

uiDisable(): disable jQuery UI
integration.

uiIsEnabled(): determine whether or not
jQuery UI integration is enabled.

setUiVersion(): set the jQuery UI version
that is used. This also decides on the library loaded
from the Google Ajax Library CDN

getUiVersion(): get the current jQuery UI
that is used. This also decides on the library loaded
from the Google Ajax Library CDN

useUiCdn(): Return true, if CDN usage is
currently enabled for jQuery UI

useUiLocal(): Return true, if local usage
is currently enabled for jQuery UI

setUiLocalPath(): Set the local path to the
jQuery UI library

getUiLocalPath(): If set, get the local path
to the jQuery UI library

jQuery Helper Utility methods

setView(Zend_View_Interface $view): set
a view instance in the container.

setCdnSsl($bool): Set if the CDN Google Ajax Library should be loaded
from an SSL or a Non-SSL location.

These are quite a number of methods, but many of them are used for internally by all the
additional view helpers and during the printing of the jQuery environment. Unless you
want to build your own jQuery helper or have a complex use-case, you will probably only
get in contact with a few methods of these.

Refactoring jQuery environment with setRenderMode()

Using the current setup that was described, each page of your website would show
a different subset of jQuery code that would be needed to keep the current jQuery related
items running. Also different files or stylesheets may be included depending on which
helpers you implemented in your application. In production stage you might want to centralize
all the javascript your application generated into a single file, or disable stylesheet
rendering because you have merged all the stylesheets into a single file and include it statically
in your layout. To allow a smooth refactoring you can enable or disable the rendering
of certain jQuery environment blocks with help of the following constants and the
jQuery()->setRenderMode($bitmask) function.

ZendX_JQuery::RENDER_ALL: Render all previously mentioned blocks, this is default behaviour.

For an example, if you would have merged jQuery Core and UI libraries as well as other files into a single large file
as well as merged stylesheets to keep HTTP requests low on your production application.
You could disallow the jQuery helper to render those parts, but render all the other stuff
with the following statement in your view:

$view->jQuery()

->setRenderMode(ZendX_JQuery::RENDER_JAVASCRIPT |

ZendX_JQuery::RENDER_JQUERY_ON_LOAD);

This statement makes sure only the required javascript statements and onLoad blocks of the current page are rendered by the jQuery helper.

Migrations

Prior to 1.8 the methods setCdnVersion(), setLocalPath()setUiCdnVersion() and setUiLocalPath() all enabled the view
helper upon calling, which is considered a bug from the following perspective: If
you want to use the any non-default library option, you would have to manually disable the
jQuery helper aftwards if you only require it to be loaded in some scenarios. With version
1.8 the jQuery helper does only enable itsself, when enable() is called,
which all internal jQuery View helpers do upon being called.

JQuery Helpers

AjaxLink Helper

The AjaxLink helper uses jQuery's ajax capabilities to offer the creation of links that do ajax requests and
inject the response into a chosen DOM element. It also offers the possibility to append simple jQuery effects
to both the link and the response DOM element. A simple example introduces its functionality:

This example creates a link with the label "Link Name" that fires an ajax request to url.php
upon click and renders the response into the div container "#container". The function header
for the ajaxLink is as follows: function ajaxLink($label, $url, $options, $params);
The options array is very powerful and offers you lots of functionality to customize your
ajax requests.

Request method, is implicitly chosen as GET when no parameters given and POST when parameters given.

complete

string

false

Javascript callback executed, when ajax request is complete. This option allows for shortcut effects, see next section.

beforeSend

string

false

Javascript callback executed right before ajax request is started. This option allows for shortcut effects, see next section.

noscript

boolean

true

If true the link generated will contain a href attribute to the given link for non-javascript enabled browsers. If false href will resolve to "#".

dataType

string

html

What type of data is the Ajax Response of? Possible are Html, Text, Json. Processing Json responses has to be done with custom "complete" callback functions.

attribs

array

null

Additional HTML attributes the ajaxable link should have.

title, id, class

string

false

Convenience shortcuts for HTML Attributes.

inline

boolean

false

Although far from best practice, you can set javascript for this link inline in "onclick" attribute.

To enlighten the usage of this helper it is best to show another bunch of more complex examples. This
example assumes that you have only one view object that you want to display and don't care a lot about
html best practices, since we have to output the jQuery environment just before the closing body tag.

You might have already seen that the 'update', 'complete', and 'beforeSend' options have to be executed in specific order and syntax so that you cannot
use those callbacks and override their behaviour completely when you are using ajaxLink(). For larger use cases you will probably want to
write the request via jQuery on your own. The primary use case for the callbacks is effect usage, other uses may very well become hard to maintain.
As shown in Example Link 5, you can also forward the beforeSend/complete Callbacks to your own javascript functions.

Shortcut Effects

You can use shortcut effect names to make your links actions more fancy. For example the Container that will contain
the ajax response may very well be invisible in the first place. Additionally you can use shortcut effects on the link
to hide it after clicking. The following effects can be used for callbacks:

complete callback: 'show', 'showslow', 'shownormal', 'showfast', 'fadein', 'fadeinslow',
'fadeinfast', 'slidedown', 'slidedownslow', 'slidedownfast'. These all correspond to the jQuery effects
fadeIn(), show() and slideDown() and will be executed on the container specified in update.

jQuery UI Library Helpers

The jQuery UI Library offers a range of layout and form specific widgets that are integrated into the
Zend Framework via View Helpers. The form-elements are easy to handle and will be described first, whereas
the layout specific widgets are a bit more complex to use.

jQuery UI Form Helpers

The method signature for all form view helpers closely resembles the Dojo View helpers signature,
helper($id, $value, $params, $attribs). A description of the parameters follows:

$id: Will act as the identifier name for the helper element inside a form. If in the attributes
no id element is given, this will also become the form element id, that has to be unique across
the DOM.

$value: Default value of the element.

$params: Widget specific parameters that customize the look and feel
of the widget. These options are unique to each widget and »
described in the jQuery UI documentation. The data is casted to JSON, so make sure
to use the Zend_Json_Expr class to mark executable javascript as safe.

$attribs: HTML Attributes of the Form Helper

The following UI widgets are available as form view helpers. Make sure you use the correct
version of jQuery UI library to be able to use them. The Google CDN always offers you the latest
released version.

autoComplete($id, $value, $params, $attribs): The AutoComplete View helper
is part of jQuery UI since version 1.8 and creates a text field and registeres
it to have auto complete functionality. The completion data source has to be given as jQuery
related parameters 'url' or 'data' as described in the jQuery UI manual.

colorPicker($id, $value, $params, $attribs): ColorPicker is still
a ZendX_JQuery element for legacy reason, but was removed from jQuery UI completly.

datePicker($id, $value, $params, $attribs): Create a DatePicker
inside a text field. This widget is available since jQuery UI 1.5 and can therefore currently be used
with the Google CDN. Using the 'handles' option to create multiple handles overwrites the default set value
and the jQuery parameter 'startValue' internally inside the view helper.

slider($id, $value, $params, $attribs): Create a Sliding element
that updates its value into a hidden form field. Available since jQuery UI 1.5.

spinner($id, $value, $params, $attribs): Create a Spinner element
that can spin through numeric values in a specified range. This element was removed from
the 1.6 jQuery UI release and has not been re-released yet.

Example #3 Showing jQuery Form View Helper Usage

In this example we want to simulate a fictional web application that offers auctions
on travel locations. A user may specify a city to travel, a start and end date, and a
maximum amount of money he is willing to pay. Therefore we need an autoComplete field
for all the currently known travel locations, a date picker for start and end dates
and a spinner to specify the amount.

You can see the use of jQuery UI Widget specific parameters. These all correspond to those given in the jQuery UI docs
and are converted to JSON and handed through to the view script.

Using an Action Helper to Send Data to AutoComplete

The jQuery UI Autocomplete Widget can load data from a remote location
rather than from an javascript array, making its usage really useful. Zend
Framework currently providers a bunch of server-side AutoComplete
Helpers and there is one for jQuery too. You register the helper
to the controller helper broker and it takes care of disabling layouts
and renders an array of data correctly to be read by the AutoComplete field.
To use the Action Helper you have to put this rather long statement into
your bootstrap or Controller initialization function:

Zend_Controller_Action_HelperBroker::addHelper(

new ZendX_JQuery_Controller_Action_Helper_AutoComplete()

);

You can then directly call the helper to render AutoComplete Output in
your Controller

jQuery UI Layout Helpers

There is a wide range of Layout helpers that the UI library offers. The ones covered by Zend Framework view helpers are
Accordion, Dialog, Tabs. Dialog is the most simple one, whereas Accordion and Tab extend a common abstract class and
offer a secondary view helper for pane generation. The following view helpers exist in the jQuery view helpers collection,
an example accompanies them to show their usage.

dialogContainer($id, $content, $params, $attribs): Create a Dialog Box that is rendered with
the given content.on startup. If the option 'autoOpen' set to false is specified the box will not be displayed
on load but can be shown with the additional dialog("open") javascript function. See UI docs
for details.

tabPane($id, $content, $options): Add a new pane to a tab container with the given $id.
The given $content is shown in this tab pane. To set the title use $options['title'].
If $options['contentUrl'] is set, the content of the tab is requested via ajax on tab activation.

tabContainer($id, $params, $attribs): Render a tab container with all the currently registered
panes. This view helper also offers to add panes with the following syntax:
$this->tabContainer()->addPane($id, $label, $content, $options).

accordionPane($id, $content, $options): Add a new pane to the accordion container with the given $id.
The given $content is shown in this tab pane. To set the title use $options['title'].

accordionContainer($id, $params, $attribs): Render an accordion container with all the currently registered
panes. This view helper also offers to add panes with the following syntax:
$this->accordionContainer()->addPane($id, $label, $content, $options).

Example #4 Showing the latest news in a Tab Container

For this example we assume the developer already wrote the controller and model side of the script and assigned
an array of news items to the view script. This array contains at most 5 news elements, so we don't have to care
about the tab container getting to many tabs.