Inheritance diagram for ApiFeedContributions:

Collaboration diagram for ApiFeedContributions:

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.
Protected Member Functions
	feedItem ($row)
	feedItemAuthor ($revision)
	feedItemDesc ($revision)

Detailed Description

Definition at line 30 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 41 of file ApiFeedContributions.php.

References $count, $limit, $params, array(), as, ApiBase\dieUsage(), ApiBase\extractRequestParams(), feedItem(), ContextSource\getConfig(), ContextSource\getContext(), ApiBase\getResult(), SpecialPage\getTitleFor(), Title\makeTitleSafe(), ApiFormatFeedWrapper\setResult(), and wfMessage().

ApiFeedContributions::feedItem ( $ row ) [protected]

Definition at line 105 of file ApiFeedContributions.php.

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

Referenced by execute().

ApiFeedContributions::feedItemAuthor ( $ revision ) [protected]

Parameters:

Revision $revision

Returns:: string

Definition at line 129 of file ApiFeedContributions.php.

Referenced by feedItem().

ApiFeedContributions::feedItemDesc ( $ revision ) [protected]

Parameters:

Revision $revision

Returns:: string

Definition at line 137 of file ApiFeedContributions.php.

References $content, $html, FeedItem\stripComment(), and wfMessage().

Referenced by feedItem().

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.

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

References array(), ContextSource\getConfig(), ChangeTags\listDefinedTags(), ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, ApiBase\PARAM_REQUIRED, and ApiBase\PARAM_TYPE.

ApiFeedContributions::getCustomPrinter ( )

This module uses a custom feed wrapper printer.

Returns:: ApiFormatFeedWrapper

Reimplemented from ApiBase.

Definition at line 37 of file ApiFeedContributions.php.

References ApiBase\getMain().

ApiFeedContributions::getDescription ( )

Returns the description string for this module.

Returns:: string|array

Reimplemented from ApiBase.

Definition at line 209 of file ApiFeedContributions.php.

ApiFeedContributions::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: bool|string|array

Reimplemented from ApiBase.

Definition at line 213 of file ApiFeedContributions.php.

References array().

ApiFeedContributions::getParamDescription ( )

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

References array().

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

includes/api/ApiFeedContributions.php

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation