Xajax中文手册(第一版)

原文：http://xajax.sourceforge.net/

英文原版：Copyright © 2005 J. Max Wilson

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

 

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

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.

 

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

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 提供了以下的功能, 它们使得ajax富有特色而又功能强大:

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:

xajax_processForm(xajax.getFormValues('formId');

. 它可以处理复杂的input 元素名称 ，例如 "checkbox[][]" 或者 "name[first]" 产生的多维或者关联数组(哈希数组), 就是普通提交表单那样使用PHP的$_GET数组

xajax_processForm(xajax.getFormValues('formId');

. It even works with complex input names like "checkbox[][]" and "name[first]" to produce multidimensional and associative arrays, just as if you had submitted the form and used the PHP $_GET array

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

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

{$xajax_javascript}

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

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

Then you can use

{$xajax_javascript}

in your header template to use xajax on your site.

Xajax的设计是如此的富有特色，以至于不管是已有的web程序还是新的项目，它都能够被极其简单的部署和应用. 仅仅需要七步，你就可以在几乎任何PHP脚本之中加入xajax的强大功能:

xajax is designed to be extremely easy to implement in both existing web applications as well as new projects. You can add the power of xajax to nearly any PHP script in seven easy steps:

require_once("xajax.inc.php");

$xajax = new xajax();

$xajax->registerFunction("myFunction");

function myFunction($arg)

{

   // 对$arg做一些基本处理例如从数据库检索数据

   // 然后把结果赋值给变量，例如$newContent

  

   // 实例化xajaxResponse 对象

   $objResponse = new xajaxResponse();

  

   // 添加指令到响应之中，用于指派

   //指定元素(例如id="SomeElementId")的innerHTML属性的新的内容

   $objResponse->addAssign("SomeElementId","innerHTML", $newContent);

  

   //返回xajaxResponse 对象生成的XML响应

   return $objResponse->getXML();

}

$xajax->processRequests();

<?php $xajax->printjavascript(); ?>

<div id="SomeElementId"></div>

<button onclick="xajax_myFunction(SomeArgument);">

require_once("xajax.inc.php");

$xajax = new xajax();

$xajax->registerFunction("myFunction");

}

$xajax->processRequests();

<?php $xajax->printjavascript(); ?>

<button onclick="xajax_myFunction(SomeArgument);">

 

就这么简单. xajax 会处理其他所有的事情. 你所要做的主要工作就是编写PHP函数，然后从函数之中返回xajax的XML响应。而后者通过xajaxResponse类可以非常简单的生成.

That's it. xajax takes care of most everything else. Your biggest task is writing the PHP functions and returning xajax XML responses from them-- which is made extremely easy by the xajaxResponse class.

 

Xajax最富有特色的功能或许就是xajaxResponse类. 其他的Ajax库需要你自己编写javascript的回调句柄去处理一个异步请求返回的数据并更新内容. xajax, 从另外一个角度来说, 允许你使用PHP简单的控制内容. xajaxResponse 让你在PHP函数之中创建XML指令返回给你的程序. XML将被xajax的消息分析器解析，指令将告诉xajax如何更新程序的内容和状态. xajaxResponse类目前提供了以下指令:

Perhaps the most unique feature of xajax is the xajaxResponse class. Other Ajax libraries require you to write your own callback handlers in javascript to process the data returned from an asynchronous request and to update the content. xajax, on the other hand, allows you to easily control your content from PHP. The xajaxResponse class allows you to create XML instructions to return to your application from your PHP functions. The XML is parsed by xajax message pump and the instructions tell xajax how to update the content and state of your application. The xajaxResponse class currently offers the following commands:

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

$objResponse->addAssign("checkBox1","checked","true");

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

$objResponse->addAssign("checkBox1","checked","true");

$objResponse->addAppend("contentDiv","innerHTML","Some Text");

$objResponse->addAppend("contentDiv","innerHTML","Some Text");

$objResponse->addPrepend("contentDiv","innerHTML","Some Text");

$objResponse->addPrepend("contentDiv","innerHTML","Some Text");

$objResponse->addReplace("contentDiv","innerHTML","text","<strong>text</strong>");

$objResponse->addReplace("contentDiv","innerHTML","text","<strong>text</strong>");

$objResponse->addClear("Input1","value");

$objResponse->addClear("Input1","value");

$objResponse->addCreate("form1","input", "pass", "password");

$objResponse->addCreate("form1","input", "pass", "password");

$objResponse->addRemove("div1");

$objResponse->addRemove("div1");

$objResponse->addAlert("This is some text");

$objResponse->addAlert("This is some text");

$objResponse->addScript("var txt = prompt('get some text');");

$objResponse->addAlert("var txt = prompt('get some text');");

 

一个独立的XML响应可能包含多个指令, 他们将按照加入响应的顺序执行. 让我们用一个用户在你的程序之中点击按钮为例来进行说明. onclick事件调用PHP函数对应的javascript封装.这个封装通过XMLHttpRequest发送异步请求到服务器给xajax调用PHP函数. PHP函数做了一次数据库查询, 处理了一些数据, 或者序列化. 然后你使用xajaxResponse类生成包含多个指令的xajax的XML响应 ，并回送给xajax的消息分析器执行:

A single XML response may contain multiple commands, which will executed in the order they were added to the response. For example, let's say that a user clicks on a button in your application. The onclick event calls the javascript wrapper for a PHP function. That wrapper sends an asynchronous request to the server through XMLHttpRequest where xajax calls the PHP function. The PHP function does a database lookup, some data manipulation, or serialization. You use the xajaxResponse class to generate an xajax XML response containing multiple commands to send back to the xajax message pump to be executed:

    $objResponse = new xajaxResponse();

    $objResponse.addAssign("myInput1","value",$DataFromDatabase);

    $objResponse.addAssign("myInput1","style.color","red");

    $objResponse.addAppend("myDiv1","innerHTML",$DataFromDatabase2);

    $objResponse.addPrepend("myDiv2","innerHTML",$DataFromDatabase3);

    $objResponse.addReplace("myDiv3","innerHTML","xajax","<strong>xajax</strong>");

    $objResponse.addScript("var x = prompt("Enter Your Name");");

           

    return $objResponse->getXML();

 

$objResponse = new xajaxResponse();

    $objResponse.addAssign("myInput1","value",$DataFromDatabase);

$objResponse.addAssign("myInput1","style.color","red");

$objResponse.addAppend("myDiv1","innerHTML",$DataFromDatabase2);

$objResponse.addPrepend("myDiv2","innerHTML",$DataFromDatabase3);

$objResponse.addReplace("myDiv3","innerHTML","xajax","<strong>xajax</strong>");

$objResponse.addScript("var x = prompt("Enter Your Name");");

return $objResponse->getXML();

xajax消息分析器将会解析XML消息，并执行以下工作:

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]

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是完全面向对象的，并且可以使用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函数:

<script type="text/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');");

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:

<script type="text/javascript">

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 PHP 类库的发布遵循 GNU Lesser General Public License (LGPL).

In short: Yes, you may.

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

 

简体中文手册版权所有 © 2005 HonestQiao(乔楚)

Copyright © 2005 J. Max Wilson