MediaWiki  REL1_24
Public Member Functions
ApiClearHasMsg Class Reference
API

API module that clears the hasmsg flag for current user. More...

Inheritance diagram for ApiClearHasMsg:
Inheritance graph
[legend]
Collaboration diagram for ApiClearHasMsg:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 execute ()
 Evaluates the parameters, performs the requested query, and sets up the result.
 getDescription ()
 Returns the description string for this module.
 getExamples ()
 Returns usage examples for this module.
 getHelpUrls ()
 isWriteMode ()
 Indicates whether this module requires write mode.
 mustBePosted ()
 Indicates whether this module must be called with a POST request.

Detailed Description

API module that clears the hasmsg flag for current user.

Definition at line 30 of file ApiClearHasMsg.php.

Member Function Documentation

ApiClearHasMsg::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 31 of file ApiClearHasMsg.php.

References $user, ApiBase\getModuleName(), ApiBase\getResult(), and ContextSource\getUser().

ApiClearHasMsg::getDescription ( )

Returns the description string for this module.

Returns:
string|array

Reimplemented from ApiBase.

Definition at line 45 of file ApiClearHasMsg.php.

References array().

ApiClearHasMsg::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:
bool|string|array

Reimplemented from ApiBase.

Definition at line 49 of file ApiClearHasMsg.php.

References array().

ApiClearHasMsg::getHelpUrls ( )
Returns:
bool|string|array Returns a false if the module has no help URL, else returns a (array of) string

Reimplemented from ApiBase.

Definition at line 55 of file ApiClearHasMsg.php.

ApiClearHasMsg::isWriteMode ( )

Indicates whether this module requires write mode.

Returns:
bool

Reimplemented from ApiBase.

Definition at line 37 of file ApiClearHasMsg.php.

ApiClearHasMsg::mustBePosted ( )

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

Returns:
bool

Reimplemented from ApiBase.

Definition at line 41 of file ApiClearHasMsg.php.

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