API Documentation

ZendX/JQuery.php

Show: inherited
Table of Contents

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.

Category
ZendX  
Copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
ZendX_JQuery  
Subpackage
View  
Version
$Id: JQuery.php 21867 2010-04-16 07:45:34Z beberlei $  

\ZendX_JQuery

Package: ZendX\JQuery

jQuery Global Class holding constants and static convienience methods.

Copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Todo
Offer convenience methods to add a tab or accordion container/pane combination.  

Constants

Constant  DEFAULT_JQUERY_VERSION = "1.3.2"

Current default supported jQuery library version with ZendX_JQuery

Const
string  
Constant  DEFAULT_UI_VERSION = "1.7.1"

Currently supported jQuery UI library version with ZendX_JQuery

Const
string  
Constant  CDN_BASE_GOOGLE = 'http://ajax.googleapis.com/ajax/libs/'

Const
string Base path to CDN  
See
\http://code.google.com/apis/ajaxlibs/documentation/index.html#jquery  
Constant  CDN_BASE_GOOGLE_SSL = 'https://ajax.googleapis.com/ajax/libs/'

Const
string Base path to CDN  
See
\http://code.google.com/apis/ajaxlibs/documentation/index.html#jquery  
Constant  CDN_SUBFOLDER_JQUERY = 'jquery/'

Const
string  
Constant  CDN_SUBFOLDER_JQUERYUI = 'jqueryui/'

Const
string  
Constant  CDN_JQUERY_PATH_GOOGLE = '/jquery.min.js'

Always uses compressed version, because this is assumed to be the use case in production enviroment. An uncompressed version has to included manually.

Const
string File path after base and version  
See
\http://code.google.com/apis/ajaxlibs/documentation/index.html#jquery  
Constant  RENDER_LIBRARY = 1

Which parts of the the jQuery library should be rendered on echo'ing the jQuery library to the View. The constants act as bit-mask. This way the jQuery autogenerated code can be refactored based on personal needs.

Const
Integer  
See
\ZendX_JQuery_Helper_JQuery::setRenderMode  
Constant  RENDER_SOURCES = 2
Constant  RENDER_STYLESHEETS = 4
Constant  RENDER_JAVASCRIPT = 8
Constant  RENDER_JQUERY_ON_LOAD = 16
Constant  RENDER_ALL = 255

Methods

methodpublicenableForm( \Zend_Form $form ) : void
static

jQuery-enable a form instance

Parameters
Name Type Description
$form \Zend_Form
methodpublicenableView( \Zend_View_Interface $view ) : void
static

jQuery-enable a view instance

Parameters
Name Type Description
$view \Zend_View_Interface
methodpublicencodeJson( mixed $value ) : mixed
static

Encode Json that may include javascript expressions.

Take care of using the Zend_Json_Encoder to alleviate problems with the json_encode magic key mechanism as of now.

Parameters
Name Type Description
$value mixed
Returns
Type Description
mixed
Details
See
\Zend_Json::encode  
Documentation was generated by DocBlox 0.15.1.