ApiLogin Class Reference

Unit to authenticate log-in attempts to the current wiki. More...

Inheritance diagram for ApiLogin:

Collaboration diagram for ApiLogin:

List of all members.

Public Member Functions
	__construct ($main, $action)
	execute ()
	Executes the log-in attempt using the parameters passed.
	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.
	getDescription ()
	Returns the description string for this module.
	getExamples ()
	Returns usage examples for this module.
	getHelpUrls ()
	getParamDescription ()
	Returns an array of parameter descriptions.
	getPossibleErrors ()
	Returns a list of all possible errors returned by the module.
	getVersion ()
	Returns a string that identifies the version of the extending class.
	isReadMode ()
	Indicates whether this module requires read rights.
	mustBePosted ()
	Indicates whether this module must be called with a POST request.

---

Detailed Description

Unit to authenticate log-in attempts to the current wiki.

Definition at line 33 of file ApiLogin.php.

---

Constructor & Destructor Documentation

ApiLogin::__construct	(	$	main,
		$	action
	)

Definition at line 35 of file ApiLogin.php.

---

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 48 of file ApiLogin.php.

References ContextSource\$context, $result, $user, $wgCookiePrefix, $wgPasswordAttemptThrottle, LoginForm\ABORTED, LoginForm\CREATE_BLOCKED, ApiBase\dieDebug(), LoginForm\EMPTY_PASS, ApiBase\extractRequestParams(), ContextSource\getContext(), ApiBase\getMain(), ContextSource\getRequest(), 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.

Here is the call graph for this function:

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 or false

Reimplemented from ApiBase.

Definition at line 175 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 193 of file ApiLogin.php.

ApiLogin::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

false|string|array

Reimplemented from ApiBase.

Definition at line 219 of file ApiLogin.php.

ApiLogin::getHelpUrls

(

)

Returns:

false|string|array Returns a false if the module has no help url, else returns a (array of) string

Reimplemented from ApiBase.

Definition at line 225 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 or false

Reimplemented from ApiBase.

Definition at line 184 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 203 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 229 of file ApiLogin.php.

ApiLogin::isReadMode

(

)

Indicates whether this module requires read rights.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 171 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 167 of file ApiLogin.php.

---

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

• includes/api/ApiLogin.php