[FEATURE] Add wincache as a cache backend
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_ajax.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2004-2011 Kasper Skårhøj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Contains the class "t3lib_ajax" containing functions for doing XMLHTTP requests to the TYPO3 backend and as well for generating replys. This technology is also known as ajax.
29 * Call ALL methods without making an object!
30 *
31 * IMPORTANT NOTICE: The API the class provides is still NOT STABLE and SUBJECT TO CHANGE!
32 * It is planned to integrate an external AJAX library, so the API will most likely change again.
33 *
34 * @author Sebastian Kurfürst <sebastian@garbage-group.de>
35 */
36
37 /**
38 * TYPO3 XMLHTTP class (new in TYPO3 4.0.0)
39 * This class contains two main parts:
40 * (1) generation of JavaScript code which creates an XMLHTTP object in a cross-browser manner
41 * (2) generation of XML data as a reply
42 *
43 * @author Sebastian Kurfürst <sebastian@garbage-group.de>
44 * @package TYPO3
45 * @subpackage t3lib
46 */
47 class t3lib_ajax {
48
49 /**
50 * Gets the JavaScript code needed to handle an XMLHTTP request in the frontend.
51 * All JS functions have to call ajax_doRequest(url) to make a request to the server.
52 * USE:
53 * See examples of using this function in template.php -> getContextMenuCode and alt_clickmenu.php -> printContent
54 *
55 * @param string $handler Function JS function handling the XML data from the server. That function gets the returned XML data as parameter.
56 * @param string $fallback JS fallback function which is called with the URL of the request in case ajax is not available.
57 * @param boolean $debug If set to 1, the returned XML data is outputted as text in an alert window - useful for debugging, PHP errors are shown there, ...
58 * @return string JavaScript code needed to make and handle an XMLHTTP request
59 */
60 function getJScode($handlerFunction, $fallback = '', $debug = 0) {
61 // Init the XMLHTTP request object
62 $code = '
63 function ajax_initObject() {
64 var A;
65 try {
66 A=new ActiveXObject("Msxml2.XMLHTTP");
67 } catch (e) {
68 try {
69 A=new ActiveXObject("Microsoft.XMLHTTP");
70 } catch (oc) {
71 A=null;
72 }
73 }
74 if (!A && typeof XMLHttpRequest != "undefined") {
75 A = new XMLHttpRequest();
76 }
77 return A;
78 }';
79 // In case AJAX is not available, fallback function
80 if ($fallback) {
81 $fallback .= '(url)';
82 } else {
83 $fallback = 'return';
84 }
85 $code .= '
86 function ajax_doRequest(url) {
87 var x;
88
89 x = ajax_initObject();
90 if (!x) {
91 ' . $fallback . ';
92 }
93 x.open("GET", url, true);
94
95 x.onreadystatechange = function() {
96 if (x.readyState != 4) {
97 return;
98 }
99 ' . ($debug ? 'alert(x.responseText)' : '') . '
100 var xmldoc = x.responseXML;
101 var t3ajax = xmldoc.getElementsByTagName("t3ajax")[0];
102 ' . $handlerFunction . '(t3ajax);
103 }
104 x.send("");
105
106 delete x;
107 }';
108
109 return $code;
110 }
111
112 /**
113 * Function outputting XML data for TYPO3 ajax. The function directly outputs headers and content to the browser.
114 *
115 * @param string $innerXML XML data which will be sent to the browser
116 * @return void
117 */
118 function outputXMLreply($innerXML) {
119 // AJAX needs some XML data
120 header('Content-Type: text/xml');
121 $xml = '<?xml version="1.0"?>
122 <t3ajax>' . $innerXML . '</t3ajax>';
123 echo $xml;
124 }
125 }
126
127 ?>