MediaWiki REL1_30
AtomFeed Class Reference

Generate an Atom feed. More...

Inheritance diagram for AtomFeed:
Collaboration diagram for AtomFeed:

Public Member Functions

 formatTime ( $timestamp)
 Format a date given timestamp.
 
 outFooter ()
 Outputs the footer for Atom 1.0 feed (basically '\</feed\>').
 
 outHeader ()
 Outputs a basic header for Atom 1.0 feeds.
 
 outItem ( $item)
 Output a given item.
 
- Public Member Functions inherited from ChannelFeed
 httpHeaders ()
 Setup and send HTTP headers.
 
- Public Member Functions inherited from FeedItem
 __construct ( $title, $description, $url, $date='', $author='', $comments='')
 
 getAuthor ()
 Get the author of this item; already xml-encoded.
 
 getComments ()
 Get the comment of this item; already xml-encoded.
 
 getDate ()
 Get the date of this item.
 
 getDescription ()
 Get the description of this item; already xml-encoded.
 
 getLanguage ()
 Get the language of this item.
 
 getTitle ()
 Get the title of this item; already xml-encoded.
 
 getUniqueId ()
 Get the unique id of this item.
 
 getUrl ()
 Get the URL of this item; already xml-encoded.
 
 setUniqueId ( $uniqueId, $rssIsPermalink=false)
 Set the unique id of an item.
 
 xmlEncode ( $string)
 Encode $string so that it can be safely embedded in a XML document.
 

Private Member Functions

 getFeedId ()
 Atom 1.0 requires a unique, opaque IRI as a unique identifier for every feed we create.
 
 getSelfUrl ()
 Atom 1.0 requests a self-reference to the feed.
 

Additional Inherited Members

- Static Public Member Functions inherited from FeedItem
static stripComment ( $text)
 Quickie hack... strip out wikilinks to more legible form from the comment.
 
- Public Attributes inherited from FeedItem
 $author
 
 $comments
 
 $date
 
 $description
 
 $rssIsPermalink = false
 
Title $title
 
 $uniqueId
 
 $url
 
- Protected Member Functions inherited from ChannelFeed
 outXmlHeader ()
 Output the initial XML headers.
 

Detailed Description

Generate an Atom feed.

Definition at line 343 of file Feed.php.

Member Function Documentation

◆ formatTime()

AtomFeed::formatTime ( $timestamp)

Format a date given timestamp.

Parameters
string | int$timestamp
Returns
string

Definition at line 350 of file Feed.php.

References wfTimestamp().

Referenced by outHeader(), and outItem().

◆ getFeedId()

AtomFeed::getFeedId ( )
private

Atom 1.0 requires a unique, opaque IRI as a unique identifier for every feed we create.

For now just use the URL, but who can tell if that's right? If we put options on the feed, do we have to change the id? Maybe? Maybe not.

Returns
string

Definition at line 384 of file Feed.php.

References getSelfUrl().

Referenced by outHeader().

◆ getSelfUrl()

AtomFeed::getSelfUrl ( )
private

Atom 1.0 requests a self-reference to the feed.

Returns
string

Definition at line 392 of file Feed.php.

References $wgRequest.

Referenced by getFeedId().

◆ outFooter()

AtomFeed::outFooter ( )

Outputs the footer for Atom 1.0 feed (basically '\</feed\>').

Reimplemented from ChannelFeed.

Definition at line 425 of file Feed.php.

◆ outHeader()

AtomFeed::outHeader ( )

Outputs a basic header for Atom 1.0 feeds.

Reimplemented from ChannelFeed.

Definition at line 358 of file Feed.php.

References $wgVersion, formatTime(), FeedItem\getDescription(), getFeedId(), FeedItem\getTitle(), href, ChannelFeed\outXmlHeader(), print, type, and wfTimestampNow().

◆ outItem()

AtomFeed::outItem ( $item)

Output a given item.

Parameters
FeedItem$item

Reimplemented from ChannelFeed.

Definition at line 401 of file Feed.php.

References $wgMimeType, formatTime(), href, print, and type.


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