ApiLogin Class Reference
[API]

Created on Sep 19, 2006. More...

Inherits ApiBase.

List of all members.

Public Member Functions

 __construct ($main, $action)
 execute ()
 Executes the log-in attempt using the parameters passed.
 mustBePosted ()
 Indicates whether this module must be called with a POST request.
 isReadMode ()
 Indicates whether this module requires read rights.
 getAllowedParams ()
 Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.
 getParamDescription ()
 Returns an array of parameter descriptions.
 getDescription ()
 Returns the description string for this module.
 getPossibleErrors ()
 Returns a list of all possible errors returned by the module.
 getVersion ()
 Returns a string that identifies the version of the extending class.

Protected Member Functions

 getExamples ()
 Returns usage examples for this module.


Detailed Description

Created on Sep 19, 2006.

API for MediaWiki 1.8+

Copyright © 2006-2007 Yuri Astrakhan <Firstname><Lastname>.com, Daniel Cannon (cannon dot danielc at gmail dot 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 the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program 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 GNU General Public License for more details.

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. http://www.gnu.org/copyleft/gpl.html Unit to authenticate log-in attempts to the current wiki.

Definition at line 37 of file ApiLogin.php.


Constructor & Destructor Documentation

ApiLogin::__construct ( main,
action 
)

Definition at line 39 of file ApiLogin.php.

References $action.


Member Function Documentation

ApiLogin::execute (  ) 

Executes the log-in attempt using the parameters passed.

If the log-in succeeeds, it attaches a cookie to the session and outputs the user id, username, and session token. If a log-in fails, as the result of a bad password, a nonexistent user, or any other reason, the host is cached with an expiry and no log-in attempts will be accepted until that expiry is reached. The expiry is $this->mLoginThrottle.

Reimplemented from ApiBase.

Definition at line 52 of file ApiLogin.php.

References $result, $wgCookiePrefix, $wgPasswordAttemptThrottle, $wgUser, LoginForm::CREATE_BLOCKED, ApiBase::dieDebug(), LoginForm::EMPTY_PASS, ApiBase::extractRequestParams(), ApiBase::getResult(), LoginForm::ILLEGAL, LoginForm::NEED_TOKEN, LoginForm::NO_NAME, LoginForm::NOT_EXISTS, LoginForm::RESET_PASS, LoginForm::SUCCESS, LoginForm::THROTTLED, LoginForm::USER_BLOCKED, wfRunHooks(), wfSetupSession(), LoginForm::WRONG_PASS, LoginForm::WRONG_PLUGIN_PASS, and LoginForm::WRONG_TOKEN.

ApiLogin::getAllowedParams (  ) 

Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.

Returns:
array

Reimplemented from ApiBase.

Definition at line 158 of file ApiLogin.php.

ApiLogin::getDescription (  ) 

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 176 of file ApiLogin.php.

ApiLogin::getExamples (  )  [protected]

Returns usage examples for this module.

Return null if no examples are available.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 202 of file ApiLogin.php.

ApiLogin::getParamDescription (  ) 

Returns an array of parameter descriptions.

Don't call this functon directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.

Returns:
array

Reimplemented from ApiBase.

Definition at line 167 of file ApiLogin.php.

ApiLogin::getPossibleErrors (  ) 

Returns a list of all possible errors returned by the module.

Returns:
array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )

Reimplemented from ApiBase.

Definition at line 186 of file ApiLogin.php.

ApiLogin::getVersion (  ) 

Returns a string that identifies the version of the extending class.

Typically includes the class name, the svn revision, timestamp, and last author. Usually done with SVN's Id keyword

Returns:
string

Reimplemented from ApiBase.

Definition at line 208 of file ApiLogin.php.

ApiLogin::isReadMode (  ) 

Indicates whether this module requires read rights.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 154 of file ApiLogin.php.

ApiLogin::mustBePosted (  ) 

Indicates whether this module must be called with a POST request.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 150 of file ApiLogin.php.


The documentation for this class was generated from the following file:

Generated on Sat Apr 30 22:57:31 2011 for MediaWiki by  doxygen 1.5.9