Xajax中文手册(第一版)

网络整理 - 07-26

原文：

简体中文翻译：HonestQiao(乔楚)/2005-12-7 17:23/(第一版)

什么是xajax?

Xajax是一个开源的 PHP 类库它能够让你黏合HTML、CSS、JavaScript和PHP，轻而易举的开发功能强大、基于WEB的AJAX应用软件. 使用xajax开发的应用软件，无需重新调入页面，就能够异步调用服务器端的PHP函数和更新内容.

What is xajax?

xajax is an open source PHP class library that allows you to easily create powerful, web-based, Ajax applications using HTML, CSS, JavaScript, and PHP. Applications developed with xajax can asynchronously call server-side PHP functions and update content without reloading the page.

xajax 如何工作?

你的应用软件需要异步调用的PHP函数， xajax的PHP对象都生成了对应的封装好了的JavaScript函数. 当被调用时，封装的函数使用JavaScript的XMLHttpRequest对象与服务器异步通讯，调用xajax对象对应的PHP函数. 调用结束后, PHP函数由xajax返回一个xajax的XML响应传递给应用程序. XML响应包含了特定的指令和数据，他们可以被xajax的JavaScript消息分析器解析，并且被用于更新你的应用程序的内容.

How does xajax work?

The xajax PHP object generates JavaScript wrapper functions for the PHP functions you want to be able to call asynchronously from your application. When called, these wrapper functions use JavaScript's XMLHttpRequest object to asynchronously communicate with the xajax object on the server which calls the corresponding PHP functions. Upon completion, an xajax XML response is returned from the PHP functions, which xajax passes back to the application. The XML response contains instructions and data that are parsed by xajax's JavaScript message pump and used to update the content of your application.

为什么我要使用xajax代替其他PHP的ajax库?

你应该选择一个最是和你的项目需要的库.

xajax 提供了以下的功能, 它们使得ajax富有特色而又功能强大:

Why should I use xajax instead of another Ajax library for PHP?

You should choose whatever library will best meet the needs of your project.

xajax offers the following features that, together, make it unique and powerful:

除了更新元素的值和内含的HTML内容(innerHTML), xajax 还能用于更新样式(styles), css 类, 多选和单选按钮选择,甚至可以更新任何元素的属性.

In addition to updating element values and innerHTML, xajax can be used to update styles, css classes, checkbox and radio button selection, or nearly any other element attribute.

xajax 支持使用一维或者多维数组、关联数组(哈希数组) 作为xajax函数的参数从javascript传送给PHP. 反之Additionally, 如果你传送一个javascript的对象给xajax函数，PHP函数将接受一个描叙对象属性的关联数组(哈希数组).

xajax supports passing single and multidimensional arrays and associative arrays from javascript to PHP as parameters to your xajax functions. Additionally, if you pass a javascript object into an xajax function, the PHP function will receive an associative array representing the properties of the object.

如果没有指定URI，xajax将设法自动确定脚本的URI. Xajax的自动确定算法经过了充分的验证，确保在大部分HTTPS或者未知端口的HTTP服务器上也可以正常的工作.

If no request URI is specified, xajax tries to autodetect the URL of the script. The xajax autodetection algorithm is sophisticated enough that, on most servers, it will work under a secure https:// protocol as well as and with nonstandard ports.

Xajax使用UTF8编码所有的请求和响应，以确保支持绝大部分的字符和语言. Xajax已经成功测试了多种不同的UNICODE字符，包括Spanish, Russian, Arabic, and Hebrew

xajax encodes all of its requests and responses in UTF-8 so that it can support a wider range of characters and languages. xajax has been successfully tested with various unicode characters including Spanish, Russian, Arabic, and Hebrew

$smarty->assign('xajax_javascript', $xajax->getJavascript());

然后你可以使用在header模版之中使用

{$xajax_javascript}

从而把xajax应用到你的站点.

}

The xajax message pump would parse the XML message and perform the following:

所有这些都由构成的PHP函数在服务器端执行并返回xajax的XML响应.

All of this is implemented on the server side in the PHP function by forming and returning an xajax XML response.

如何异步处理表单数据?

Xajax使得异步处理表单数句非常非常的简单. xajax.getFormValues()方法会自动的从表单提取数据，并作为一个参数提交给xajax注册的PHP函数.

xajax.getFormValues() 仅仅需要一个参数, 可以是你需要处理得表单的id, 或者是一个实际的表单对象. 你也可以使用xajax.getFormValues作为一个参数给xajax 函数, 例如:

xajax_processFormData(xajax.getFormValues('formId'));

xajax 会生成一个与表单数据对应的请求字符串给xajax服务器解析，然后以一个与表单数据对应的数组传递给PHP函数，就想你提交表单使用PHP的$_GET数组那么简单.

Xajax可以处理类似普通多维数组或者联合数组(哈希数组)等形式的复杂输入名字. 例如, 如果一个表单有三个多选框(checkboxes)并且都命名为 "checkbox[]", 但是值分别为 "check1", "check2", 和 "check3", 然后使用 xajax.getFormValues 函数作为参数传递给xajax 函数, 则 PHP 函数会接受到一个如下的数组:

array (

'checkbox' =>

array (

0 => 'check1',

1 => 'check2',

2 => 'check3',

)

作为函数参数的数组的结构与传统意义上提交表单之后的$_GET数组的结构相同. 你可以访问数组之中的checkbox 的数据: $aFormData['checkbox'][0]

How do I process form data asynchronously?

xajax makes processing form data asynchronously extremely easy. The xajax.getFormValues() method can be used to automatically extract the data from a form and pass it as a parameter to a PHP function you have registered with xajax.

xajax.getFormValues() takes one argument, which can be either the id of the form you want to process, or the actual form object. You use xajax.getFormValues as a parameter to your xajax function, like this:

xajax_processFormData(xajax.getFormValues('formId'));

xajax generates a query string representing the form data which is parsed by the xajax server and passed to your PHP function as an array representing the form data, just as if you had submitted the form and used the PHP $_GET array.

xajax will even handle complex input names to generate multidimensional and associative arrays. For instance, if you have a form with three checkboxes and you give them all the name "checkbox[]", but different values like "check1", "check2", and "check3", and you use the xajax.getFormValues function as a parameter to your xajax function, the PHP function will receive and array that looks like this:

array (

'checkbox' =>

array (

0 => 'check1',

1 => 'check2',

2 => 'check3',

)

The array argument to your function mirrors the structure that the $_GET array would have if you were to submit the form traditionally. You can then access the checkbox data in the array like this:

$aFormData['checkbox'][0]

如何给xajax增加定制功能?

Xajax可以使用各种服加的用户定制功能进行扩展. 正因为xajax是完全面向对象的，并且可以使用xajaxResponse的addScript()方法，所以他具有无限扩展的可能. 你可以创建你自己的xajax响应类，来继承xajaxResponse 类以及它的方法，并加上你自己定制的响应. 让我们用一个定制的增加选择组合框(select combo boxes)选项的响应指令的例子来说明. 你可以象下面这样扩展xajaxResponse 类:

class myXajaxResponse extends xajaxResponse

{

function addAddOption($sSelectId, $sOptionText, $sOptionValue)

{

$sScript = "var objOption = new Option('".$sOptionText."','".$sOptionValue."');";

$sScript .= "document.getElementById('".$sSelectId."').options.add(objOption);";

$this->addScript($sScript);

}

现在, 取代xajaxResponse 对象的初始化, 把你自己的 myXajaxResponse 对象的初始化定义到你的 xajax PHP 函数之中:

$objResponse = new myXajaxResponse();

$objResponse->addAssign("div1", "innerHTML", "Some Text");

$objResponse->addAddOption("select1","New Option","13");

return $objResponse->getXML();

被调用时，这个方法将会发送需要的javascript到页面并执行. 当然你也有另外一种做法Alternatively, 你可以在你的程序之中创建一个如下的javascript函数:

function addOption(selectId,txt,val)

{

var objOption = new Option(txt,val);

document.getElementById(selectId).options.add(objOption);

}

</script>

并且使用addScript() 调用这个方法:

$objResponse->addScript("addOption('select1','New Option','13');");

How do I add custom functionality to xajax?

xajax can be extended with all kinds of additional custom functionality. The extendability of xajax is made possible because it is object oriented, and by the addScript() method of the xajaxResponse class. You can create your own xajax response class that extends the xajaxResponse class and has all of the normal xajaxResponse methods, plus your own custom responses. For instance, let's say that you wanted to add a custom response command to add options to select combo boxes. You could extend the xajaxResponse class like this:

class myXajaxResponse extends xajaxResponse

{

function addAddOption($sSelectId, $sOptionText, $sOptionValue)

{

$sScript = "var objOption = new Option('".$sOptionText."','".$sOptionValue."');";

$sScript .= "document.getElementById('".$sSelectId."').options.add(objOption);";

$this->addScript($sScript);

}

Now, instead of instantiating an xajaxResponse object, you instantiate and use your myXajaxResponse object in your xajax PHP functions:

$objResponse = new myXajaxResponse();

$objResponse->addAssign("div1", "innerHTML", "Some Text");

$objResponse->addAddOption("select1","New Option","13");

return $objResponse->getXML();

This method would send the necessary javascript to the page when it was called and execute it. Alternatively, you could create a javascript function in your application:

function addOption(selectId,txt,val)

{

var objOption = new Option(txt,val);

document.getElementById(selectId).options.add(objOption);

}

</script>

and call it with the addScript() method:

$objResponse->addScript("addOption('select1','New Option','13');");

我能在私有或者收费产品之中使用xajax吗?

简而言之: 能，只要你愿意.

xajax PHP 类库的发布遵循 GNU Lesser General Public License (LGPL).

May I use xajax in a proprietary product and charge for it?

In short: Yes, you may.

The xajax PHP class library is released under the GNU Lesser General Public License (LGPL).