TYPO3 and xajax quick guide
Tuesday, November 20th, 2007Ajax is definetly the thing to go with the web as it enhance the user experience as well as allowing more logic to be on the server side (okey, your pages javascript usualy tend to get slightly more bloated as well..).
Anyway. It’s not ajax in general today, but the good looking PHP/ajax combination found with the xajax project. Xajax allows you to have PHP functions that you mapp/register as javascript calls. There is an extension for TYPO3 called – xajax! You guessed it! There are two tutorial/example extensions as well that describes how it works. But for my memory I’m writing a short guide here as well with my own words. Maybe it helps someone else.
Using ajax in your backend module:
- Do the obvious. Install the xajax extension from TER (ie TYPO3 Extension Repository).
- Launch your favourite editor and open your module file like – /typo3conf/ext/myext/mod1/index.php
- Include the ajax class
-
// DEFAULT initialization of a module [BEGIN]unset($MCONF);require_once(‘conf.php’);require_once($BACK_PATH.’init.php’);
-
require_once($BACK_PATH.‘template.php’);
-
// include XAJAX class library
-
require (t3lib_extMgm::extPath(‘xajax’) . ‘class.tx_xajax.php’);
-
$LANG->includeLLFile(‘EXT:myext/mod1/locallang.xml’);
-
…
- Somewhere in your init() method register your PHP function
- In your printContent() method add this to ensure that xajax does whatever it wants (ie handle requests..) first
-
$this->xajax->processRequests();
- Then create your nifty PHP function where you want to do magic, and add a responce object like this:
-
function xajaxTest() {
-
$c = "ohlas!";// Instantiate the tx_xajax_response object
-
$objResponse = new tx_xajax_response();
-
$objResponse->addAssign("mydiv","innerHTML", $c);//return the XML response generated by the tx_xajax_response object
-
return $objResponse->getXML();
-
}
- Now finally add a call to your function. This is probably done in moduleContent() or referenced functions
-
<a href="#" onClick="xajax_xajaxTest();">xajax magic</a>
Note that we got an extra xajax_ added to the beginning of our function which is added automatically.
That’s it folks!