<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Zend Framework Extras API Documentation</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><link rel="stylesheet" href="../css/template.css" type="text/css"></link><script type="text/javascript" src="../js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="../js/jquery.tools.min.js"></script><script type="text/javascript" src="../js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="../js/template.js"></script></head><body><div id="content"><h1 class="file">JQuery.php</h1><div id="file-nav-box"><div id="file-nav-options">
Show:
<img src="../images/icons/visibility_public.png" alt="Public" id="show-public"></img><img src="../images/icons/visibility_protected.png" alt="Protected" id="show-protected"></img><img src="../images/icons/visibility_private.png" alt="Private" id="show-private"></img><span class="attribute" id="show-inherited">inherited</span></div><div id="file-nav-container"><ul id="file-nav"><li><a href="#classes"><img src="../images/icons/class.png" alt="Class" height="14"></img>
Classes
</a><ul><li><a href="#\ZendX_JQuery">\ZendX_JQuery</a></li></ul></li></ul><div style="clear: left;"></div></div><div id="file-nav-tab">
Table of Contents
</div></div><a name="top" class="anchor"></a><div id="file-description"><div class="short-description">Zend Framework</div><div class="long-description"><p>LICENSE</p>
<p>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.</p></div></div><dl class="file-info"><dt>Category</dt><dd>ZendX
</dd><dt>Copyright</dt><dd>Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
</dd><dt>License</dt><dd><a href="http://framework.zend.com/license/new-bsd">New BSD License</a>
</dd><dt>Package</dt><dd>ZendX_JQuery
</dd><dt>Subpackage</dt><dd>View
</dd><dt>Version</dt><dd>$Id: JQuery.php 21867 2010-04-16 07:45:34Z beberlei $
</dd></dl><a name="classes" class="anchor"></a><a id="\ZendX_JQuery" class="anchor"></a><h2 class="class">\ZendX_JQuery<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>ZendX\JQuery</small><div class="short-description">jQuery Global Class holding constants and static convienience methods.</div><div class="long-description"></div><dl class="class-info"><dt>Copyright</dt><dd>Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
</dd><dt>License</dt><dd><a href="http://framework.zend.com/license/new-bsd">New BSD License</a>
</dd><dt>Todo</dt><dd>Offer convenience methods to add a tab or accordion container/pane combination.
</dd></dl><h3>Constants</h3><div><a id="\ZendX_JQuery::DEFAULT_JQUERY_VERSION" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img>
<span class="highlight">DEFAULT_JQUERY_VERSION</span>
= "1.3.2"</code><div class="description"><div class="short-description">Current default supported jQuery library version with ZendX_JQuery</div></div><div class="code-tabs"><div class="long-description"></div><dl class="constant-info"><dt>Const</dt><dd>string
</dd></dl></div><div class="clear"></div></div><a id="\ZendX_JQuery::DEFAULT_UI_VERSION" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img>
<span class="highlight">DEFAULT_UI_VERSION</span>
= "1.7.1"</code><div class="description"><div class="short-description">Currently supported jQuery UI library version with ZendX_JQuery</div></div><div class="code-tabs"><div class="long-description"></div><dl class="constant-info"><dt>Const</dt><dd>string
</dd></dl></div><div class="clear"></div></div><a id="\ZendX_JQuery::CDN_BASE_GOOGLE" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img>
<span class="highlight">CDN_BASE_GOOGLE</span>
= 'http://ajax.googleapis.com/ajax/libs/'</code><div class="description"></div><div class="code-tabs"><div class="long-description"></div><dl class="constant-info"><dt>Const</dt><dd>string Base path to CDN
</dd><dt>See</dt><dd>\http://code.google.com/apis/ajaxlibs/documentation/index.html#jquery
</dd></dl></div><div class="clear"></div></div><a id="\ZendX_JQuery::CDN_BASE_GOOGLE_SSL" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img>
<span class="highlight">CDN_BASE_GOOGLE_SSL</span>
= 'https://ajax.googleapis.com/ajax/libs/'</code><div class="description"></div><div class="code-tabs"><div class="long-description"></div><dl class="constant-info"><dt>Const</dt><dd>string Base path to CDN
</dd><dt>See</dt><dd>\http://code.google.com/apis/ajaxlibs/documentation/index.html#jquery
</dd></dl></div><div class="clear"></div></div><a id="\ZendX_JQuery::CDN_SUBFOLDER_JQUERY" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img>
<span class="highlight">CDN_SUBFOLDER_JQUERY</span>
= 'jquery/'</code><div class="description"></div><div class="code-tabs"><div class="long-description"></div><dl class="constant-info"><dt>Const</dt><dd>string
</dd></dl></div><div class="clear"></div></div><a id="\ZendX_JQuery::CDN_SUBFOLDER_JQUERYUI" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img>
<span class="highlight">CDN_SUBFOLDER_JQUERYUI</span>
= 'jqueryui/'</code><div class="description"></div><div class="code-tabs"><div class="long-description"></div><dl class="constant-info"><dt>Const</dt><dd>string
</dd></dl></div><div class="clear"></div></div><a id="\ZendX_JQuery::CDN_JQUERY_PATH_GOOGLE" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img>
<span class="highlight">CDN_JQUERY_PATH_GOOGLE</span>
= '/jquery.min.js'</code><div class="description"><div class="short-description">Always uses compressed version, because this is assumed to be the use case
in production enviroment.</div></div><div class="code-tabs"><div class="long-description"><p>An uncompressed version has to included manually.</p></div><dl class="constant-info"><dt>Const</dt><dd>string File path after base and version
</dd><dt>See</dt><dd>\http://code.google.com/apis/ajaxlibs/documentation/index.html#jquery
</dd></dl></div><div class="clear"></div></div><a id="\ZendX_JQuery::RENDER_LIBRARY" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img>
<span class="highlight">RENDER_LIBRARY</span>
= 1</code><div class="description"><div class="short-description">Which parts of the the jQuery library should be rendered on echo'ing
the jQuery library to the View.</div></div><div class="code-tabs"><div class="long-description"><p>The constants act as bit-mask. This
way the jQuery autogenerated code can be refactored based on personal needs.</p></div><dl class="constant-info"><dt>Const</dt><dd>Integer
</dd><dt>See</dt><dd>\ZendX_JQuery_Helper_JQuery::setRenderMode
</dd></dl></div><div class="clear"></div></div><a id="\ZendX_JQuery::RENDER_SOURCES" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img>
<span class="highlight">RENDER_SOURCES</span>
= 2</code><div class="description"></div><div class="code-tabs"></div><div class="clear"></div></div><a id="\ZendX_JQuery::RENDER_STYLESHEETS" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img>
<span class="highlight">RENDER_STYLESHEETS</span>
= 4</code><div class="description"></div><div class="code-tabs"></div><div class="clear"></div></div><a id="\ZendX_JQuery::RENDER_JAVASCRIPT" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img>
<span class="highlight">RENDER_JAVASCRIPT</span>
= 8</code><div class="description"></div><div class="code-tabs"></div><div class="clear"></div></div><a id="\ZendX_JQuery::RENDER_JQUERY_ON_LOAD" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img>
<span class="highlight">RENDER_JQUERY_ON_LOAD</span>
= 16</code><div class="description"></div><div class="code-tabs"></div><div class="clear"></div></div><a id="\ZendX_JQuery::RENDER_ALL" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img>
<span class="highlight">RENDER_ALL</span>
= 255</code><div class="description"></div><div class="code-tabs"></div><div class="clear"></div></div></div><h3>Methods</h3><div><a id="\ZendX_JQuery::enableForm()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">enableForm</span><span class="nb-faded-text">(\Zend_Form $form)</span> : void</code><div class="description"><span class="attribute">static</span><p class="short_description">jQuery-enable a form instance</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$form</th><td>\Zend_Form</td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\ZendX_JQuery::enableView()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">enableView</span><span class="nb-faded-text">(\Zend_View_Interface $view)</span> : void</code><div class="description"><span class="attribute">static</span><p class="short_description">jQuery-enable a view instance</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$view</th><td>\Zend_View_Interface</td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\ZendX_JQuery::encodeJson()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">encodeJson</span><span class="nb-faded-text">(mixed $value)</span> : mixed</code><div class="description"><span class="attribute">static</span><p class="short_description">Encode Json that may include javascript expressions.</p></div><div class="code-tabs"><div class="long-description"><p>Take care of using the Zend_Json_Encoder to alleviate problems with the json_encode
magic key mechanism as of now.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$value</th><td>mixed</td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>mixed</td><td></td></tr></table><strong>Details</strong><dl class="function-info"><dt>See</dt><dd>\Zend_Json::encode
</dd></dl></div><div class="clear"></div></div></div></div></div><small class="footer">
Documentation was generated by
<a href="http://phpdoc.org">phpDocumentor
2.0.0a12</a>.
</small></body></html>
