API Documentation

JQuery.php

Includes Classes 
category
ZendX
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
ZendX_JQuery
subpackage
View
version
$Id: JQuery.php 21867 2010-04-16 07:45:34Z beberlei $
Classes
ZendX_JQuery

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.

ZendX_JQuery

copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
ZendX_JQuery
todo
Offer convenience methods to add a tab or accordion container/pane combination.
Constants
DEFAULT_JQUERY_VERSION
DEFAULT_UI_VERSION
CDN_BASE_GOOGLE
CDN_BASE_GOOGLE_SSL
CDN_SUBFOLDER_JQUERY
CDN_SUBFOLDER_JQUERYUI
CDN_JQUERY_PATH_GOOGLE
RENDER_LIBRARY
RENDER_SOURCES
RENDER_STYLESHEETS
RENDER_JAVASCRIPT
RENDER_JQUERY_ON_LOAD
RENDER_ALL
Methods
enableView
enableForm
encodeJson

Description

jQuery Global Class holding constants and static convienience methods.

Constants

DEFAULT_JQUERY_VERSION

 DEFAULT_JQUERY_VERSION = '1.3.2'

Current default supported jQuery library version with ZendX_JQuery

Details

value
1.3.2
const
string

DEFAULT_UI_VERSION

 DEFAULT_UI_VERSION = '1.7.1'

Currently supported jQuery UI library version with ZendX_JQuery

Details

value
1.7.1
const
string

CDN_BASE_GOOGLE

 CDN_BASE_GOOGLE = 'http://ajax.googleapis.com/ajax/libs/'

Details

value
http://ajax.googleapis.com/ajax/libs/
const
string Base path to CDN
see
http://code.google.com/apis/ajaxlibs/documentation/index.html#jquery

CDN_BASE_GOOGLE_SSL

 CDN_BASE_GOOGLE_SSL = 'https://ajax.googleapis.com/ajax/libs/'

Details

value
https://ajax.googleapis.com/ajax/libs/
const
string Base path to CDN
see
http://code.google.com/apis/ajaxlibs/documentation/index.html#jquery

CDN_SUBFOLDER_JQUERY

 CDN_SUBFOLDER_JQUERY = 'jquery/'

Details

value
jquery/
const
string

CDN_SUBFOLDER_JQUERYUI

 CDN_SUBFOLDER_JQUERYUI = 'jqueryui/'

Details

value
jqueryui/
const
string

CDN_JQUERY_PATH_GOOGLE

 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.

Details

value
/jquery.min.js
const
string File path after base and version
see
http://code.google.com/apis/ajaxlibs/documentation/index.html#jquery

RENDER_LIBRARY

 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.

Details

value
1
const
Integer
see
ZendX_JQuery_Helper_JQuery::setRenderMode

RENDER_SOURCES

 RENDER_SOURCES = '2'

Details

value
2

RENDER_STYLESHEETS

 RENDER_STYLESHEETS = '4'

Details

value
4

RENDER_JAVASCRIPT

 RENDER_JAVASCRIPT = '8'

Details

value
8

RENDER_JQUERY_ON_LOAD

 RENDER_JQUERY_ON_LOAD = '16'

Details

value
16

RENDER_ALL

 RENDER_ALL = '255'

Details

value
255

Methods

enableForm

enableForm( Zend_Form $form ) : void

jQuery-enable a form instance

Arguments
$form
Zend_Form
Details
visibility
public
final
false
static
true

enableView

enableView( Zend_View_Interface $view ) : void

jQuery-enable a view instance

Arguments
$view
Zend_View_Interface
Details
visibility
public
final
false
static
true

encodeJson

encodeJson( mixed $value ) : mixed

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.

Arguments
$value
mixed
Output
mixed
Details
visibility
public
final
false
static
true
see
Zend_Json::encode
Documentation was generated by DocBlox.