MediaWiki  master
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, if one is given. More...
 
 outFooter ()
 Outputs the footer for Atom 1.0 feed (basically '\</feed\>'). More...
 
 outHeader ()
 Outputs a basic header for Atom 1.0 feeds. More...
 
 outItem ( $item)
 Output a given item. More...
 
- Public Member Functions inherited from ChannelFeed
 __construct ( $title, $description, $url, $date='', $author='', $comments='')
 
 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='')
 
 getAuthor ()
 Get the author of this item; already xml-encoded. More...
 
 getAuthorUnescaped ()
 Get the author of this item without any escaping. More...
 
 getComments ()
 Get the comment of this item; already xml-encoded. More...
 
 getCommentsUnescaped ()
 Get the comment of this item without any escaping. More...
 
 getDate ()
 Get the date of this item. More...
 
 getDescription ()
 Get the description of this item; already xml-encoded. More...
 
 getDescriptionUnescaped ()
 Get the description of this item without any escaping. 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; already xml-encoded. More...
 
 getUniqueIdUnescaped ()
 Get the unique id of this item, without any escaping. More...
 
 getUrl ()
 Get the URL of this item; already xml-encoded. More...
 
 getUrlUnescaped ()
 Get the URL of this item without any escaping. 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...
 

Private Member Functions

 getFeedId ()
 Atom 1.0 requires a unique, opaque IRI as a unique identifier for every feed we create. More...
 
 getSelfUrl ()
 Atom 1.0 requests a self-reference to the feed. 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
 
- Protected Member Functions inherited from ChannelFeed
 outXmlHeader ()
 Output the initial XML headers. More...
 
- Protected Attributes inherited from ChannelFeed
TemplateParser $templateParser
 

Detailed Description

Generate an Atom feed.

Definition at line 29 of file AtomFeed.php.

Member Function Documentation

◆ formatTime()

AtomFeed::formatTime (   $timestamp)

Format a date given timestamp, if one is given.

Parameters
string | int | null$timestamp
Returns
string|null

Definition at line 36 of file AtomFeed.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 72 of file AtomFeed.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 80 of file AtomFeed.php.

References $wgRequest.

Referenced by getFeedId(), and outHeader().

◆ outFooter()

AtomFeed::outFooter ( )

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

Definition at line 108 of file AtomFeed.php.

References print.

◆ outHeader()

◆ outItem()

AtomFeed::outItem (   $item)

Output a given item.

Parameters
FeedItem$item

Definition at line 89 of file AtomFeed.php.

References $wgMimeType, formatTime(), print, PROTO_CURRENT, wfExpandUrl(), and FeedItem\xmlEncode().


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