MediaWiki  REL1_19
Public Member Functions | Protected Member Functions
ApiFeedContributions Class Reference
API
Inheritance diagram for ApiFeedContributions:
Inheritance graph
[legend]
Collaboration diagram for ApiFeedContributions:
Collaboration graph
[legend]

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.
 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.
 getVersion ()
 Returns a string that identifies the version of the extending class.

Protected Member Functions

 feedItem ($row)
 feedItemAuthor ($revision)
 feedItemDesc ($revision)

Detailed Description

Definition at line 30 of file ApiFeedContributions.php.

Constructor & Destructor Documentation

ApiFeedContributions::__construct ( $  main,
$  action 
)

Definition at line 32 of file ApiFeedContributions.php.

Member Function Documentation

ApiFeedContributions::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 45 of file ApiFeedContributions.php.

References $wgFeed, $wgFeedClasses, $wgLanguageCode, $wgMiserMode, $wgSitename, ApiBase\dieUsage(), ApiBase\extractRequestParams(), feedItem(), ContextSource\getContext(), ApiBase\getResult(), SpecialPage\getTitleFor(), Title\makeTitleSafe(), ApiFormatFeedWrapper\setResult(), and wfMsgForContent().

Here is the call graph for this function:

ApiFeedContributions::feedItem ( $  row) [protected]

Definition at line 98 of file ApiFeedContributions.php.

References $title, feedItemAuthor(), feedItemDesc(), and Revision\newFromRow().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

ApiFeedContributions::feedItemAuthor ( $  revision) [protected]
Parameters:
$revisionRevision
Returns:
string

Definition at line 122 of file ApiFeedContributions.php.

Referenced by feedItem().

Here is the caller graph for this function:

ApiFeedContributions::feedItemDesc ( $  revision) [protected]
Parameters:
$revisionRevision
Returns:
string

Definition at line 130 of file ApiFeedContributions.php.

References FeedItem\stripComment(), and wfMsgForContent().

Referenced by feedItem().

Here is the call graph for this function:

Here is the caller graph for this function:

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

References $wgFeedClasses, ChangeTags\listDefinedTags(), ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.

Here is the call graph for this function:

ApiFeedContributions::getCustomPrinter ( )

This module uses a custom feed wrapper printer.

Returns:
ApiFormatFeedWrapper

Reimplemented from ApiBase.

Definition at line 41 of file ApiFeedContributions.php.

References ApiBase\getMain().

Here is the call graph for this function:

ApiFeedContributions::getDescription ( )

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 187 of file ApiFeedContributions.php.

ApiFeedContributions::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:
false|string|array

Reimplemented from ApiBase.

Definition at line 199 of file ApiFeedContributions.php.

ApiFeedContributions::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 173 of file ApiFeedContributions.php.

ApiFeedContributions::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 191 of file ApiFeedContributions.php.

ApiFeedContributions::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 205 of file ApiFeedContributions.php.

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