ApiFormatFeedWrapper Class Reference
[API]

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

Inherits ApiFormatBase.

List of all members.

Public Member Functions

 __construct ($main)
 getMimeType ()
 Feed does its own headers.
 getNeedsRawData ()
 Optimization - no need to sanitize data that will not be needed.
 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.
 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 259 of file ApiFormatBase.php.


Constructor & Destructor Documentation

ApiFormatFeedWrapper::__construct ( main  ) 

Definition at line 261 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 302 of file ApiFormatBase.php.

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

ApiFormatFeedWrapper::getMimeType (  ) 

Feed does its own headers.

Reimplemented from ApiFormatBase.

Definition at line 286 of file ApiFormatBase.php.

ApiFormatFeedWrapper::getNeedsRawData (  ) 

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

Reimplemented from ApiFormatBase.

Definition at line 293 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 318 of file ApiFormatBase.php.

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

Call this method to initialize output data.

See execute()

Parameters:
$result ApiResult
$feed object an instance of one of the $wgFeedClasses classes
$feedItems array of FeedItem objects

Definition at line 271 of file ApiFormatBase.php.

References $result.

Referenced by ApiFeedWatchlist::execute().


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

Generated on Sat Sep 5 02:08:30 2009 for MediaWiki by  doxygen 1.5.9