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

---

Constructor & Destructor Documentation

ApiFormatFeedWrapper::__construct

(

$

main

)

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

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

ApiFormatFeedWrapper::getMimeType

(

)

Feed does its own headers.

Returns:

null

Reimplemented from ApiFormatBase.

Definition at line 364 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 373 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
array	$feedItems	of FeedItem objects

Definition at line 347 of file ApiFormatBase.php.

References $result.

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

---

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

• includes/api/ApiFormatBase.php