MediaWiki  REL1_23
Public Member Functions
ApiFeedRecentChanges Class Reference
API

Recent changes feed. More...

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

List of all members.

Public Member Functions

 execute ()
 Format the rows (generated by SpecialRecentchanges or SpecialRecentchangeslinked) as an RSS/Atom feed.
 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.
 getFeedObject ($feedFormat, $specialClass)
 Return a ChannelFeed object.
 getParamDescription ()
 Returns an array of parameter descriptions.
 getPossibleErrors ()
 Returns a list of all possible errors returned by the module.

Detailed Description

Recent changes feed.

Definition at line 27 of file ApiFeedRecentChanges.php.

Member Function Documentation

ApiFeedRecentChanges::execute ( )

Format the rows (generated by SpecialRecentchanges or SpecialRecentchangeslinked) as an RSS/Atom feed.

Reimplemented from ApiBase.

Definition at line 42 of file ApiFeedRecentChanges.php.

References array(), ChangesFeed\buildItems(), ApiBase\dieUsage(), ApiBase\extractRequestParams(), getFeedObject(), ApiBase\getMain(), ApiBase\getParameter(), ApiBase\getResult(), global, and ApiFormatFeedWrapper\setResult().

ApiFeedRecentChanges::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 112 of file ApiFeedRecentChanges.php.

References $ret, array(), global, ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, ApiBase\PARAM_MAX, ApiBase\PARAM_MIN, and ApiBase\PARAM_TYPE.

ApiFeedRecentChanges::getCustomPrinter ( )

This module uses a custom feed wrapper printer.

Returns:
ApiFormatFeedWrapper

Reimplemented from ApiBase.

Definition at line 34 of file ApiFeedRecentChanges.php.

References ApiBase\getMain().

ApiFeedRecentChanges::getDescription ( )

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 196 of file ApiFeedRecentChanges.php.

ApiFeedRecentChanges::getExamples ( )

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 ApiFeedRecentChanges.php.

References array().

ApiFeedRecentChanges::getFeedObject ( $  feedFormat,
$  specialClass 
)

Return a ChannelFeed object.

Parameters:
string$feedFormatFeed's format (either 'rss' or 'atom')
string$specialClassRelevant special page name (either 'SpecialRecentchanges' or 'SpecialRecentchangeslinked')
Returns:
ChannelFeed

Definition at line 86 of file ApiFeedRecentChanges.php.

References $title, array(), ApiBase\dieUsageMsg(), SpecialPage\getTitleFor(), ContextSource\msg(), Title\newFromText(), and text.

Referenced by execute().

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

References array().

ApiFeedRecentChanges::getPossibleErrors ( )

Returns a list of all possible errors returned by the module.

Don't call this function directly: use getFinalPossibleErrors() to allow hooks to modify parameters as needed.

Returns:
array in the format of array( key, param1, param2, ... ) or array( 'code' => ..., 'info' => ... )

Reimplemented from ApiBase.

Definition at line 200 of file ApiFeedRecentChanges.php.

References array().

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