ApiLogout Class Reference

API module to allow users to log out of the wiki. More...

Inheritance diagram for ApiLogout:

Collaboration diagram for ApiLogout:

List of all members.

Public Member Functions
	__construct ($main, $action)
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.
	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.
	getVersion ()
	Returns a string that identifies the version of the extending class.
	isReadMode ()
	Indicates whether this module requires read rights.

---

Detailed Description

API module to allow users to log out of the wiki.

API equivalent of Special:Userlogout.

Definition at line 33 of file ApiLogout.php.

---

Constructor & Destructor Documentation

ApiLogout::__construct	(	$	main,
		$	action
	)

Definition at line 35 of file ApiLogout.php.

---

Member Function Documentation

ApiLogout::execute

(

)

Evaluates the parameters, performs the requested query, and sets up the result.

Concrete implementations of ApiBase must override this method to provide whatever functionality their module offers. Implementations must not produce any output on their own and are not expected to handle any errors.

The execute() method will be invoked directly by ApiMain immediately before the result of the module is output. Aside from the constructor, implementations should assume that no other methods will be called externally on the module before the result is processed.

The result data should be stored in the ApiResult object available through getResult().

Reimplemented from ApiBase.

Definition at line 39 of file ApiLogout.php.

References $user, ContextSource\getUser(), and wfRunHooks().

Here is the call graph for this function:

ApiLogout::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 53 of file ApiLogout.php.

ApiLogout::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 61 of file ApiLogout.php.

ApiLogout::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

false|string|array

Reimplemented from ApiBase.

Definition at line 65 of file ApiLogout.php.

ApiLogout::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 71 of file ApiLogout.php.

ApiLogout::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 57 of file ApiLogout.php.

ApiLogout::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 75 of file ApiLogout.php.

ApiLogout::isReadMode

(

)

Indicates whether this module requires read rights.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 49 of file ApiLogout.php.

---

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

• includes/api/ApiLogout.php