Fixed issue #13670: Performance optimization: change while(list() to foreach() (thank...
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_ajax.php
index 71dfc12..9df5afd 100644 (file)
@@ -2,7 +2,7 @@
 /***************************************************************
 *  Copyright notice
 *
-*  (c) 2004-2005 Kasper Skaarhoj (kasperYYYY@typo3.com)
+*  (c) 2004-2009 Kasper Skaarhoj (kasperYYYY@typo3.com)
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
  */
 class t3lib_ajax {
        /**
       * gets 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  $handlerFunction        JS function handling the XML data from the server. That function gets the returned XML data as parameter.
       * @param       string  $fallback               JS fallback function which is called with the URL of the request in case ajax is not available.
       * @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, ...
       * @return      string  JavaScript code needed to make and handle an XMLHTTP request
       */
-       function getJScode($handlerFunction, $fallback = '', $debug=0)  {
-                       // init xmlhttp request object
* 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;
@@ -75,7 +75,7 @@ class t3lib_ajax {
                        }
                        return A;
                }';
-                       // in case ajax is not available, fallback function
+                       // in case AJAX is not available, fallback function
                if($fallback)   {
                        $fallback .= '(url)';
                } else {
@@ -111,11 +111,11 @@ class t3lib_ajax {
        /**
         * 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
+        * @param       string          $innerXML       XML data which will be sent to the browser
         * @return      void
         */
        function outputXMLreply($innerXML)      {
-                       // ajax needs xml data
+                       // AJAX needs some XML data
                header('Content-Type: text/xml');
                $xml = '<?xml version="1.0"?>
 <t3ajax>'.$innerXML.'</t3ajax>';
@@ -128,4 +128,4 @@ class t3lib_ajax {
 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']);
 }
-?>
+?>
\ No newline at end of file