ApiBase.php:
[lhc/web/wiklou.git] / includes / api / ApiLogout.php
index 6b09e8f..72b646e 100644 (file)
@@ -1,11 +1,10 @@
 <?php
-
-/*
- * Created on Jan 4, 2008
- *
+/**
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 2008 Yuri Astrakhan <Firstname><Lastname>@gmail.com,
+ * Created on Jan 4, 2008
+ *
+ * Copyright © 2008 Yuri Astrakhan <Firstname><Lastname>@gmail.com,
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
-if (!defined('MEDIAWIKI')) {
+if ( !defined( 'MEDIAWIKI' ) ) {
        // Eclipse helper - will be ignored in production
-       require_once ('ApiBase.php');
+       require_once( 'ApiBase.php' );
 }
 
 /**
- * API module to allow users to log out of the wiki. API equivalent of 
+ * API module to allow users to log out of the wiki. API equivalent of
  * Special:Userlogout.
  *
- * @addtogroup API
+ * @ingroup API
  */
 class ApiLogout extends ApiBase {
 
-       public function __construct($main, $action) {
-               parent :: __construct($main, $action);
+       public function __construct( $main, $action ) {
+               parent::__construct( $main, $action );
        }
 
        public function execute() {
                global $wgUser;
+               $oldName = $wgUser->getName();
                $wgUser->logout();
+
+               // Give extensions to do something after user logout
+               $injected_html = '';
+               wfRunHooks( 'UserLogoutComplete', array( &$wgUser, &$injected_html, $oldName ) );
        }
 
-       protected function getAllowedParams() {
-               return array ();
+       public function isReadMode() {
+               return false;
        }
 
-       protected function getParamDescription() {
-               return array ();
+       public function getAllowedParams() {
+               return array();
        }
 
-       protected function getDescription() {
-               return array (
-                       'This module is used to logout and clear session data'
-               );
+       public function getParamDescription() {
+               return array();
+       }
+
+       public function getDescription() {
+               return 'This module is used to logout and clear session data';
        }
 
        protected function getExamples() {