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