Inherits ApiBase.
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. | |
getVersion () | |
Returns a string that identifies the version of the extending class. | |
Protected Member Functions | |
getExamples () | |
Returns usage examples for this module. |
Definition at line 37 of file ApiLogin.php.
ApiLogin::__construct | ( | $ | main, | |
$ | action | |||
) |
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 54 of file ApiLogin.php.
References $result, $wgCookiePrefix, $wgPasswordAttemptThrottle, $wgUser, LoginForm::CREATE_BLOCKED, ApiBase::dieDebug(), LoginForm::EMPTY_PASS, ApiBase::extractRequestParams(), ApiBase::getResult(), LoginForm::ILLEGAL, LoginForm::NO_NAME, LoginForm::NOT_EXISTS, LoginForm::SUCCESS, LoginForm::THROTTLED, wfRunHooks(), wfSetupSession(), LoginForm::WRONG_PASS, and LoginForm::WRONG_PLUGIN_PASS.
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.
Reimplemented from ApiBase.
Definition at line 132 of file ApiLogin.php.
ApiLogin::getDescription | ( | ) |
Returns the description string for this module.
Reimplemented from ApiBase.
Definition at line 148 of file ApiLogin.php.
ApiLogin::getExamples | ( | ) | [protected] |
Returns usage examples for this module.
Return null if no examples are available.
Reimplemented from ApiBase.
Definition at line 158 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.
Reimplemented from ApiBase.
Definition at line 140 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
Reimplemented from ApiBase.
Definition at line 164 of file ApiLogin.php.
ApiLogin::isReadMode | ( | ) |
Indicates whether this module requires read rights.
Reimplemented from ApiBase.
Definition at line 128 of file ApiLogin.php.
ApiLogin::mustBePosted | ( | ) |
Indicates whether this module must be called with a POST request.
Reimplemented from ApiBase.
Definition at line 126 of file ApiLogin.php.