ApiEmailUser Class Reference

API Module to facilitate sending of emails to users. More...

Inheritance diagram for ApiEmailUser:

Collaboration diagram for ApiEmailUser:

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.
	getPossibleErrors ()
	Returns a list of all possible errors returned by the module.
	getTokenSalt ()
	Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the module doesn't need a token.
	getVersion ()
	Returns a string that identifies the version of the extending class.
	isWriteMode ()
	Indicates whether this module requires write mode.
	mustBePosted ()
	Indicates whether this module must be called with a POST request.
	needsToken ()
	Returns whether this module requires a Token to execute.

---

Detailed Description

API Module to facilitate sending of emails to users.

Definition at line 31 of file ApiEmailUser.php.

---

Constructor & Destructor Documentation

ApiEmailUser::__construct	(	$	main,
		$	action
	)

Definition at line 33 of file ApiEmailUser.php.

---

Member Function Documentation

ApiEmailUser::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 37 of file ApiEmailUser.php.

References $result, ApiBase\dieUsageMsg(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), SpecialEmailUser\getPermissionsError(), ApiBase\getResult(), SpecialEmailUser\getTarget(), ContextSource\getUser(), and SpecialEmailUser\submit().

Here is the call graph for this function:

ApiEmailUser::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 90 of file ApiEmailUser.php.

References ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.

ApiEmailUser::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 116 of file ApiEmailUser.php.

ApiEmailUser::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

false|string|array

Reimplemented from ApiBase.

Definition at line 134 of file ApiEmailUser.php.

ApiEmailUser::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 140 of file ApiEmailUser.php.

ApiEmailUser::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 106 of file ApiEmailUser.php.

ApiEmailUser::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 120 of file ApiEmailUser.php.

ApiEmailUser::getTokenSalt

(

)

Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the module doesn't need a token.

Returns:

bool|string

Reimplemented from ApiBase.

Definition at line 130 of file ApiEmailUser.php.

ApiEmailUser::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 144 of file ApiEmailUser.php.

ApiEmailUser::isWriteMode

(

)

Indicates whether this module requires write mode.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 86 of file ApiEmailUser.php.

ApiEmailUser::mustBePosted

(

)

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

Returns:

bool

Reimplemented from ApiBase.

Definition at line 82 of file ApiEmailUser.php.

ApiEmailUser::needsToken

(

)

Returns whether this module requires a Token to execute.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 126 of file ApiEmailUser.php.

---

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

• includes/api/ApiEmailUser.php