MediaWiki  master
ChannelFeed Class Reference

Class to support the outputting of syndication feeds in Atom and RSS format. More...

Inheritance diagram for ChannelFeed:
Collaboration diagram for ChannelFeed:

Public Member Functions

 httpHeaders ()
 Setup and send HTTP headers. More...
 
 outFooter ()
 Generate Footer of the feed. More...
 
 outHeader ()
 Generate Header of the feed. More...
 
 outItem ($item)
 Generate an item. More...
 
- Public Member Functions inherited from FeedItem
 __construct ($title, $description, $url, $date= '', $author= '', $comments= '')
 Constructor. More...
 
 getAuthor ()
 Get the author of this item; already xml-encoded. More...
 
 getComments ()
 Get the comment of this item; already xml-encoded. More...
 
 getDate ()
 Get the date of this item. More...
 
 getDescription ()
 Get the description of this item; already xml-encoded. More...
 
 getLanguage ()
 Get the language of this item. More...
 
 getTitle ()
 Get the title of this item; already xml-encoded. More...
 
 getUniqueId ()
 Get the unique id of this item. More...
 
 getUrl ()
 Get the URL of this item; already xml-encoded. More...
 
 setUniqueId ($uniqueId, $rssIsPermalink=false)
 Set the unique id of an item. More...
 
 xmlEncode ($string)
 Encode $string so that it can be safely embedded in a XML document. More...
 

Protected Member Functions

 outXmlHeader ()
 Output the initial XML headers. More...
 

Private Member Functions

 contentType ()
 Return an internet media type to be sent in the headers. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from FeedItem
static stripComment ($text)
 Quickie hack... More...
 
- Public Attributes inherited from FeedItem
 $author
 
 $comments
 
 $date
 
 $description
 
 $rssIsPermalink = false
 
Title $title
 
 $uniqueId
 
 $url
 

Detailed Description

Class to support the outputting of syndication feeds in Atom and RSS format.

Definition at line 191 of file Feed.php.

Member Function Documentation

ChannelFeed::contentType ( )
private

Return an internet media type to be sent in the headers.

Returns
string

Definition at line 246 of file Feed.php.

References $wgRequest, and global.

Referenced by httpHeaders().

ChannelFeed::httpHeaders ( )

Setup and send HTTP headers.

Don't send any content; content might end up being cached and re-sent with these same headers later.

This should be called from the outHeader() method, but can also be called separately.

Definition at line 228 of file Feed.php.

References $wgOut, $wgVaryOnXFP, contentType(), and global.

Referenced by outXmlHeader().

ChannelFeed::outFooter ( )
abstract

Generate Footer of the feed.

Example:
print "</feed>";
ChannelFeed::outHeader ( )
abstract

Generate Header of the feed.

Example:
print "<feed>";
ChannelFeed::outItem (   $item)
abstract

Generate an item.

Example:
print "<item>...</item>";
Parameters
FeedItem$item
ChannelFeed::outXmlHeader ( )
protected

Output the initial XML headers.

Definition at line 263 of file Feed.php.

References httpHeaders().

Referenced by RSSFeed\outHeader(), and AtomFeed\outHeader().


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