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

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

簡(jiǎn)體中文翻譯：HonestQiao(喬楚)/2005-12-7 17:23/(第一版)

 

Xajax是一個(gè)開(kāi)源的 PHP 類(lèi)庫(kù) 它能夠讓你黏合HTML、CSS、javascript和PHP，輕而易舉的開(kāi)發(fā)功能強(qiáng)大、基于WEB的AJAX應(yīng)用軟件. 使用xajax開(kāi)發(fā)的應(yīng)用軟件，無(wú)需重新調(diào)入頁(yè)面，就能夠異步調(diào)用服務(wù)器端的PHP函數(shù)和更新內(nèi)容.

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.

 

你的應(yīng)用軟件需要異步調(diào)用的PHP函數(shù)， xajax的PHP對(duì)象都生成了對(duì)應(yīng)的封裝好了的javascript函數(shù). 當(dāng)被調(diào)用時(shí)，封裝的函數(shù)使用javascript的XMLHttpRequest對(duì)象與服務(wù)器異步通訊，調(diào)用xajax對(duì)象對(duì)應(yīng)的PHP函數(shù). 調(diào)用結(jié)束后, PHP函數(shù)由xajax返回一個(gè)xajax的XML響應(yīng)傳遞給應(yīng)用程序. XML響應(yīng)包含了特定的指令和數(shù)據(jù)，他們可以被xajax的javascript消息分析器解析，并且被用于更新你的應(yīng)用程序的內(nèi)容.

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.

你應(yīng)該選擇一個(gè)最是和你的項(xiàng)目需要的庫(kù).

xajax 提供了以下的功能, 它們使得ajax富有特色而又功能強(qiáng)大:

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');

. 它可以處理復(fù)雜的input 元素名稱(chēng) ，例如 "checkbox[][]" 或者 "name[first]" 產(chǎn)生的多維或者關(guān)聯(lián)數(shù)組(哈希數(shù)組), 就是普通提交表單那樣使用PHP的$_GET數(shù)組

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應(yīng)用到你的站點(diǎn).

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

Then you can use

{$xajax_javascript}

in your header template to use xajax on your site.

Xajax的設(shè)計(jì)是如此的富有特色，以至于不管是已有的web程序還是新的項(xiàng)目，它都能夠被極其簡(jiǎn)單的部署和應(yīng)用. 僅僅需要七步，你就可以在幾乎任何PHP腳本之中加入xajax的強(qiáng)大功能:

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)

{

   // 對(duì)$arg做一些基本處理例如從數(shù)據(jù)庫(kù)檢索數(shù)據(jù)

   // 然后把結(jié)果賦值給變量，例如$newContent

  

   // 實(shí)例化xajaxResponse 對(duì)象

   $objResponse = new xajaxResponse();

  

   // 添加指令到響應(yīng)之中，用于指派

   //指定元素(例如id="SomeElementId")的innerHTML屬性的新的內(nèi)容

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

  

   //返回xajaxResponse 對(duì)象生成的XML響應(yīng)

   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);">

 

就這么簡(jiǎn)單. xajax 會(huì)處理其他所有的事情. 你所要做的主要工作就是編寫(xiě)PHP函數(shù)，然后從函數(shù)之中返回xajax的XML響應(yīng)。而后者通過(guò)xajaxResponse類(lèi)可以非常簡(jiǎn)單的生成.

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類(lèi). 其他的Ajax庫(kù)需要你自己編寫(xiě)javascript的回調(diào)句柄去處理一個(gè)異步請(qǐng)求返回的數(shù)據(jù)并更新內(nèi)容. xajax, 從另外一個(gè)角度來(lái)說(shuō), 允許你使用PHP簡(jiǎn)單的控制內(nèi)容. xajaxResponse 讓你在PHP函數(shù)之中創(chuàng)建XML指令返回給你的程序. XML將被xajax的消息分析器解析，指令將告訴xajax如何更新程序的內(nèi)容和狀態(tài). xajaxResponse類(lèi)目前提供了以下指令:

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');");

 

一個(gè)獨(dú)立的XML響應(yīng)可能包含多個(gè)指令, 他們將按照加入響應(yīng)的順序執(zhí)行. 讓我們用一個(gè)用戶在你的程序之中點(diǎn)擊按鈕為例來(lái)進(jìn)行說(shuō)明. onclick事件調(diào)用PHP函數(shù)對(duì)應(yīng)的javascript封裝.這個(gè)封裝通過(guò)XMLHttpRequest發(fā)送異步請(qǐng)求到服務(wù)器給xajax調(diào)用PHP函數(shù). PHP函數(shù)做了一次數(shù)據(jù)庫(kù)查詢, 處理了一些數(shù)據(jù), 或者序列化. 然后你使用xajaxResponse類(lèi)生成包含多個(gè)指令的xajax的XML響應(yīng) ，并回送給xajax的消息分析器執(zhí)行:

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消息分析器將會(huì)解析XML消息，并執(zhí)行以下工作:

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

所有這些都由構(gòu)成的PHP函數(shù)在服務(wù)器端執(zhí)行并返回xajax的XML響應(yīng).

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

Xajax使得異步處理表單數(shù)句非常非常的簡(jiǎn)單. xajax.getFormValues()方法會(huì)自動(dòng)的從表單提取數(shù)據(jù)，并作為一個(gè)參數(shù)提交給xajax注冊(cè)的PHP函數(shù).

xajax.getFormValues() 僅僅需要一個(gè)參數(shù), 可以是你需要處理得表單的id, 或者是一個(gè)實(shí)際的表單對(duì)象. 你也可以使用xajax.getFormValues作為一個(gè)參數(shù)給xajax 函數(shù), 例如:

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

xajax 會(huì)生成一個(gè)與表單數(shù)據(jù)對(duì)應(yīng)的請(qǐng)求字符串給xajax服務(wù)器解析，然后以一個(gè)與表單數(shù)據(jù)對(duì)應(yīng)的數(shù)組傳遞給PHP函數(shù)，就想你提交表單使用PHP的$_GET數(shù)組那么簡(jiǎn)單.

Xajax可以處理類(lèi)似普通多維數(shù)組或者聯(lián)合數(shù)組(哈希數(shù)組)等形式的復(fù)雜輸入名字. 例如, 如果一個(gè)表單有三個(gè)多選框(checkboxes)并且都命名為 "checkbox[]", 但是值分別為 "check1", "check2", 和 "check3", 然后使用 xajax.getFormValues 函數(shù)作為參數(shù)傳遞給xajax 函數(shù), 則 PHP 函數(shù)會(huì)接受到一個(gè)如下的數(shù)組:

array (

  'checkbox' =>

  array (

    0 => 'check1',

    1 => 'check2',

    2 => 'check3',

  ),

)

作為函數(shù)參數(shù)的數(shù)組的結(jié)構(gòu)與傳統(tǒng)意義上提交表單之后的$_GET數(shù)組的結(jié)構(gòu)相同. 你可以訪問(wèn)數(shù)組之中的checkbox 的數(shù)據(jù): $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可以使用各種服加的用戶定制功能進(jìn)行擴(kuò)展. 正因?yàn)閤ajax是完全面向?qū)ο蟮模⑶铱梢允褂脁ajaxResponse的addScript()方法，所以他具有無(wú)限擴(kuò)展的可能. 你可以創(chuàng)建你自己的xajax響應(yīng)類(lèi)，來(lái)繼承xajaxResponse 類(lèi)以及它的方法，并加上你自己定制的響應(yīng). 讓我們用一個(gè)定制的增加選擇組合框(select combo boxes)選項(xiàng)的響應(yīng)指令的例子來(lái)說(shuō)明. 你可以象下面這樣擴(kuò)展xajaxResponse 類(lèi):

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);

  }

}

現(xiàn)在, 取代xajaxResponse 對(duì)象的初始化, 把你自己的 myXajaxResponse 對(duì)象的初始化定義到你的 xajax PHP 函數(shù)之中:

$objResponse = new myXajaxResponse();

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

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

 

return $objResponse->getXML();

被調(diào)用時(shí)，這個(gè)方法將會(huì)發(fā)送需要的javascript到頁(yè)面并執(zhí)行. 當(dāng)然你也有另外一種做法Alternatively, 你可以在你的程序之中創(chuàng)建一個(gè)如下的javascript函數(shù):

<script type="text/javascript">

function addOption(selectId,txt,val)

{

        var objOption = new Option(txt,val);

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

}

</script>

并且使用addScript() 調(diào)用這個(gè)方法:

$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');");

簡(jiǎn)而言之: 能，只要你愿意.

xajax PHP 類(lèi)庫(kù)的發(fā)布遵循 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).

 

簡(jiǎn)體中文手冊(cè)版權(quán)所有 © 2005 HonestQiao(喬楚)

Copyright © 2005 J. Max Wilson