MediaWiki  REL1_19
Public Member Functions | Static Public Member Functions
ApiFormatFeedWrapper Class Reference
API

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

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

List of all members.

Public Member Functions

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

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 333 of file ApiFormatBase.php.

Constructor & Destructor Documentation

ApiFormatFeedWrapper::__construct ( $  main)

Definition at line 335 of file ApiFormatBase.php.

Member Function Documentation

ApiFormatFeedWrapper::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.

Reimplemented from ApiBase.

Definition at line 380 of file ApiFormatBase.php.

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

Here is the call graph for this function:

ApiFormatFeedWrapper::getMimeType ( )

Feed does its own headers.

Returns:
null

Reimplemented from ApiFormatBase.

Definition at line 362 of file ApiFormatBase.php.

ApiFormatFeedWrapper::getNeedsRawData ( )

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

Returns:
bool

Reimplemented from ApiFormatBase.

Definition at line 371 of file ApiFormatBase.php.

ApiFormatFeedWrapper::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 397 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
$feedItemsarray of FeedItem objects

Definition at line 345 of file ApiFormatBase.php.

References $result.

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

Here is the caller graph for this function:

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