Merge "Remove useless test in getParamValue function of mediawiki.util.js"

[lhc/web/wiklou.git] / includes / api / ApiLogout.php

diff --git a/includes/api/ApiLogout.php b/includes/api/ApiLogout.php
index 000409e..cab2430 100644 (file)
--- a/includes/api/ApiLogout.php
+++ b/includes/api/ApiLogout.php
@@ -1,11 +1,10 @@
 <?php
-
-/*
- * Created on Jan 4, 2008
+/**
+ *
  *
- * API for MediaWiki 1.8+
+ * Created on Jan 4, 2008
  *
- * Copyright (C) 2008 Yuri Astrakhan <Firstname><Lastname>@gmail.com,
+ * 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
@@ -19,15 +18,12 @@
  *
  * 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')) {
-       // Eclipse helper - will be ignored in production
-       require_once ('ApiBase.php');
-}
-
 /**
  * API module to allow users to log out of the wiki. API equivalent of
  * Special:Userlogout.
@@ -36,40 +32,50 @@ if (!defined('MEDIAWIKI')) {
  */
 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();
-               
+               $user = $this->getUser();
+               $oldName = $user->getName();
+               $user->logout();
+
                // Give extensions to do something after user logout
                $injected_html = '';
-               wfRunHooks( 'UserLogoutComplete', array(&$wgUser, &$injected_html, $oldName) );
+               wfRunHooks( 'UserLogoutComplete', array( &$user, &$injected_html, $oldName ) );
+       }
+
+       public function isReadMode() {
+               return false;
        }
 
        public function getAllowedParams() {
-               return array ();
+               return array();
+       }
+
+       public function getResultProperties() {
+               return array();
        }
 
        public function getParamDescription() {
-               return array ();
+               return array();
        }
 
        public function getDescription() {
-               return array (
-                       'This module is used to logout and clear session data'
-               );
+               return 'Log out and clear session data';
        }
 
-       protected function getExamples() {
+       public function getExamples() {
                return array(
-                       'api.php?action=logout'
+                       'api.php?action=logout' => 'Log the current user out',
                );
        }
 
+       public function getHelpUrls() {
+               return 'https://www.mediawiki.org/wiki/API:Logout';
+       }
+
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }