Public Member Functions | |
| 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. | |
| getCustomPrinter () | |
| This module uses a custom feed wrapper printer. | |
| getDescription () | |
| Returns the description string for this module. | |
| getExamples () | |
| Returns usage examples for this module. | |
| getParamDescription () | |
| Returns an array of parameter descriptions. | |
| getPossibleErrors () | |
| Returns a list of all possible errors returned by the module. | |
Protected Member Functions | |
| feedItem ($row) | |
| feedItemAuthor ($revision) | |
| feedItemDesc ($revision) | |
Detailed Description
Definition at line 30 of file ApiFeedContributions.php.
Member Function Documentation
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 41 of file ApiFeedContributions.php.
References $params, array(), as, ApiBase\dieUsage(), ApiBase\extractRequestParams(), feedItem(), ContextSource\getContext(), ApiBase\getResult(), SpecialPage\getTitleFor(), global, Title\makeTitleSafe(), ApiFormatFeedWrapper\setResult(), and wfMessage().
| ApiFeedContributions::feedItem | ( | $ | row | ) | [protected] |
Definition at line 94 of file ApiFeedContributions.php.
References $title, feedItemAuthor(), feedItemDesc(), Title\makeTitle(), and Revision\newFromRow().
Referenced by execute().
| ApiFeedContributions::feedItemAuthor | ( | $ | revision | ) | [protected] |
- Parameters:
-
$revision Revision
- Returns:
- string
Definition at line 118 of file ApiFeedContributions.php.
Referenced by feedItem().
| ApiFeedContributions::feedItemDesc | ( | $ | revision | ) | [protected] |
- Parameters:
-
$revision Revision
- Returns:
- string
Definition at line 126 of file ApiFeedContributions.php.
References $html, FeedItem\stripComment(), and wfMessage().
Referenced by feedItem().
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.
Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.
- Returns:
- array|bool
Reimplemented from ApiBase.
Definition at line 149 of file ApiFeedContributions.php.
References array(), global, ChangeTags\listDefinedTags(), ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.
This module uses a custom feed wrapper printer.
- Returns:
- ApiFormatFeedWrapper
Reimplemented from ApiBase.
Definition at line 37 of file ApiFeedContributions.php.
References ApiBase\getMain().
Returns the description string for this module.
- Returns:
- mixed string or array of strings
Reimplemented from ApiBase.
Definition at line 195 of file ApiFeedContributions.php.
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 207 of file ApiFeedContributions.php.
References array().
Returns an array of parameter descriptions.
Don't call this function directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.
- Returns:
- array|bool False on no parameter descriptions
Reimplemented from ApiBase.
Definition at line 181 of file ApiFeedContributions.php.
References array().
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 199 of file ApiFeedContributions.php.
References array().
The documentation for this class was generated from the following file:
- includes/api/ApiFeedContributions.php
