MediaWiki  REL1_23
ApiFormatFeedWrapper Class Reference

This printer is used to wrap an instance of the Feed class. More...

Inheritance diagram for ApiFormatFeedWrapper:
Collaboration diagram for ApiFormatFeedWrapper:

List of all members.

Public Member Functions

 __construct ($main)
 canPrintErrors ()
 ChannelFeed doesn't give us a method to print errors in a friendly manner, so just punt errors to the default printer.
 execute ()
 This class expects the result data to be in a custom format set by self::setResult() $result['_feed'] - an instance of one of the $wgFeedClasses classes $result['_feeditems'] - an array of FeedItem instances.
 getMimeType ()
 Feed does its own headers.
 getNeedsRawData ()
 Optimization - no need to sanitize data that will not be needed.

Static Public Member Functions

static setResult ($result, $feed, $feedItems)
 Call this method to initialize output data.

Detailed Description

This printer is used to wrap an instance of the Feed class.

Definition at line 348 of file ApiFormatBase.php.


Constructor & Destructor Documentation

Definition at line 350 of file ApiFormatBase.php.


Member Function Documentation

ChannelFeed doesn't give us a method to print errors in a friendly manner, so just punt errors to the default printer.

Returns:
false

Reimplemented from ApiFormatBase.

Definition at line 395 of file ApiFormatBase.php.

This class expects the result data to be in a custom format set by self::setResult() $result['_feed'] - an instance of one of the $wgFeedClasses classes $result['_feeditems'] - an array of FeedItem instances.

Reimplemented from ApiBase.

Definition at line 404 of file ApiFormatBase.php.

References as, ApiBase\dieDebug(), and ApiBase\getResultData().

Feed does its own headers.

Returns:
null

Reimplemented from ApiFormatBase.

Definition at line 377 of file ApiFormatBase.php.

Optimization - no need to sanitize data that will not be needed.

Returns:
bool

Reimplemented from ApiFormatBase.

Definition at line 386 of file ApiFormatBase.php.

static ApiFormatFeedWrapper::setResult ( result,
feed,
feedItems 
) [static]

Call this method to initialize output data.

See execute()

Parameters:
$resultApiResult
$feedobject an instance of one of the $wgFeedClasses classes
array$feedItemsof FeedItem objects

Definition at line 360 of file ApiFormatBase.php.

References $result.

Referenced by ApiFeedContributions\execute(), ApiFeedRecentChanges\execute(), and ApiFeedWatchlist\execute().


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