xajax

The xajax extension integrates the xajax PHP class library ( ) into eZ publish. It allows you to easily create powerful, web-based, Ajax applications.

Features

The xajax extension only contains the base files needed to make your eZ publish installation ready for xajax. Specific xajax functions are placed in other extensions.

xajax extensions

Currently there are 3 eZ publish extensions publicly released which contain xajax plugins:

• xajax_classattributes enhances the class/edit view
• xajax_preferences lets you set user preferences
• xajax_roleedit enhances the role/edit view
• xajax_autosuggest transforms the search field in the administration interface to an autosuggest control.

License

xajax is copyright © 2005-2006 SCK•CEN and is distributed under the GNU LGPL.

It was written by Kristof Coomans. Other contributors include: Bruce Morisson

Requirements

In order to use this extension without any problems, you should meet the following requirements.

eZ publish

This extension should work on the following versions of eZ publish:

• 3.6.x
• 3.7.x
• 3.8.x

Rewrite rules

Make sure the rewrite rules of your Apache virtual host configuration allow direct access to JavaScript files inside extensions. Using the rewrite rules mentioned at should work fine.

Supported user agents

You'll need a user agent that is supported by the xajax library:

• Firefox
• Mozilla
• probably other Mozilla based browsers
• Internet Explorer
• Safari
• Opera

Installation

Download

You can download the xajax extension from it's contribution page at ez.no or you can check it out right from the community subversion repository at pubsvn.

Install the extension

Follow the steps described in the eZ publish technical manual to extract and activate the extension.

Move settings file

Move or copy the xajax.ini file from the install directory of the xajax extension to the main settings directory in your eZ publish root directory.
Skipping this installation step won't harm, but it's better if the settings file is located at the right place so you can easily find it.

Insert xajax JavaScript

Insert the necessary xajax JavaScript between the opening and closing head tags in your pagelayouts. You can use the xajax_javascript template operator to do this. You won't register new functions with xajax regularly, so you can place it in a non-expiring cache block.

{cache-block ignore_content_expiry expiry=0}
{xajax_javascript()}
{/cache-block}

Add module policy

Add a policy for the xajax module to the desired roles.

Clear caches

You will probably need to clear the INI and template caches.

External links

• xajax contribution page at ez.no