]> scripts.mit.edu Git - autoinstalls/mediawiki.git/blobdiff - includes/api/ApiLogout.php
MediaWiki 1.17.4
[autoinstalls/mediawiki.git] / includes / api / ApiLogout.php
index 8b178f6a951e01464edc786350b56f03a9374ca0..72b646ed4ed9062184d151c9d9d6a7d9ef32d976 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' );
 }
 
 /**
@@ -36,32 +37,34 @@ 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();
-               
+
                // Give extensions to do something after user logout
                $injected_html = '';
-               wfRunHooks( 'UserLogoutComplete', array(&$wgUser, &$injected_html, $oldName) );
+               wfRunHooks( 'UserLogoutComplete', array( &$wgUser, &$injected_html, $oldName ) );
+       }
+
+       public function isReadMode() {
+               return false;
        }
 
        public function getAllowedParams() {
-               return array ();
+               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 'This module is used to logout and clear session data';
        }
 
        protected function getExamples() {
@@ -71,6 +74,6 @@ class ApiLogout extends ApiBase {
        }
 
        public function getVersion() {
-               return __CLASS__ . ': $Id: ApiLogout.php 43522 2008-11-15 01:23:39Z brion $';
+               return __CLASS__ . ': $Id$';
        }
 }