[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/api/ -> ApiFormatFeedWrapper.php (summary)

Created on Sep 19, 2006 Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"

File Size: 101 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ApiFormatFeedWrapper:: (6 methods):
  __construct()
  setResult()
  getMimeType()
  getNeedsRawData()
  canPrintErrors()
  execute()


Class: ApiFormatFeedWrapper  - X-Ref

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

__construct( ApiMain $main )   X-Ref
No description

setResult( $result, $feed, $feedItems )   X-Ref
Call this method to initialize output data. See execute()

param: ApiResult $result
param: object $feed An instance of one of the $wgFeedClasses classes
param: array $feedItems Array of FeedItem objects

getMimeType()   X-Ref
Feed does its own headers

return: null

getNeedsRawData()   X-Ref
Optimization - no need to sanitize data that will not be needed

return: bool

canPrintErrors()   X-Ref
ChannelFeed doesn't give us a method to print errors in a friendly
manner, so just punt errors to the default printer.

return: bool

execute()   X-Ref
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




Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1