Only changes to function indexes, comments and stripping of trailing whitespace in...
[Packages/TYPO3.CMS.git] / typo3 / logout.php
index e1ace7a..e33a599 100755 (executable)
@@ -1,22 +1,22 @@
 <?php
 /***************************************************************
 *  Copyright notice
-*  
-*  (c) 1999-2003 Kasper Skaarhoj (kasper@typo3.com)
+*
+*  (c) 1999-2004 Kasper Skaarhoj (kasper@typo3.com)
 *  All rights reserved
 *
-*  This script is part of the TYPO3 project. The TYPO3 project is 
+*  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 
+*  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
@@ -24,7 +24,7 @@
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
-/** 
+/**
  * Logout script for the backend
  * This script saves the interface positions and calls the closeTypo3Windows in the frameset
  *
  *
  *
  *
- *   61: class SC_logout 
- *   68:     function logout() 
+ *   62: class SC_logout
+ *   69:     function logout()
  *
  * TOTAL FUNCTIONS: 1
  * (This index is automatically created/updated by the extension "extdeveval")
  *
  */
+
 require ('init.php');
 
 
@@ -52,8 +52,9 @@ require ('init.php');
 
 
 /**
- * Script Class
- * 
+ * Script Class for logging a user out.
+ * Does not display any content, just calls the logout-function for the current user and then makes a redirect.
+ *
  * @author     Kasper Skaarhoj <kasper@typo3.com>
  * @package TYPO3
  * @subpackage core
@@ -61,9 +62,9 @@ require ('init.php');
 class SC_logout {
 
        /**
-        * Logout
-        * 
-        * @return      void            
+        * Performs the logout processing
+        *
+        * @return      void
         */
        function logout()       {
                global $BE_USER;
@@ -71,7 +72,7 @@ class SC_logout {
                $BE_USER->writelog(255,2,0,1,'User %s logged out from TYPO3 Backend',Array($BE_USER->user['username']));        // Logout written to log
                $BE_USER->logoff();
 
-               header('Location: '.t3lib_div::locationHeaderUrl(t3lib_div::GPvar('redirect')?t3lib_div::GPvar('redirect'):'index.php'));
+               header('Location: '.t3lib_div::locationHeaderUrl(t3lib_div::_GP('redirect')?t3lib_div::_GP('redirect'):'index.php'));
        }
 }