ApiEmailUser Class Reference
[API]

Inherits ApiBase.

List of all members.

Public Member Functions

 __construct ($main, $action)
 execute ()
 Evaluates the parameters, performs the requested query, and sets up the result.
 mustBePosted ()
 Indicates whether this module must be called with a POST request.
 isWriteMode ()
 Indicates whether this module requires write mode.
 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.


Detailed Description

Definition at line 34 of file ApiEmailUser.php.


Constructor & Destructor Documentation

ApiEmailUser::__construct ( main,
action 
)

Definition at line 36 of file ApiEmailUser.php.

References $action.


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

References $error, $result, $wgUser, ApiBase::dieUsageMsg(), ApiBase::extractRequestParams(), ApiBase::getModuleName(), EmailUserForm::getPermissionsError(), ApiBase::getResult(), EmailUserForm::userEmailEnabled(), and EmailUserForm::validateEmailTarget().

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

Reimplemented from ApiBase.

Definition at line 83 of file ApiEmailUser.php.

ApiEmailUser::getDescription (  ) 

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 103 of file ApiEmailUser.php.

ApiEmailUser::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 109 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

Reimplemented from ApiBase.

Definition at line 93 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 115 of file ApiEmailUser.php.

ApiEmailUser::isWriteMode (  ) 

Indicates whether this module requires write mode.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 79 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 77 of file ApiEmailUser.php.


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

Generated on Sat Sep 5 02:08:30 2009 for MediaWiki by  doxygen 1.5.9