Generate an Atom feed. More...
Public Member Functions | |
| formatTime ( $timestamp) | |
| Format a date given timestamp, if one is given. | |
| 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 | |
| __construct ( $title, $description, $url, $date='', $author='', $comments='') | |
| httpHeaders () | |
| Setup and send HTTP headers. | |
| Public Member Functions inherited from FeedItem | |
| getAuthor () | |
| Get the author of this item; already xml-encoded. | |
| getAuthorUnescaped () | |
| Get the author of this item without any escaping. | |
| getComments () | |
| Get the comment of this item; already xml-encoded. | |
| getCommentsUnescaped () | |
| Get the comment of this item without any escaping. | |
| getDate () | |
| Get the date of this item. | |
| getDescription () | |
| Get the description of this item; already xml-encoded. | |
| getDescriptionUnescaped () | |
| Get the description of this item without any escaping. | |
| 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; already xml-encoded. | |
| getUniqueIdUnescaped () | |
| Get the unique id of this item, without any escaping. | |
| getUrl () | |
| Get the URL of this item; already xml-encoded. | |
| getUrlUnescaped () | |
| Get the URL of this item without any escaping. | |
| 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. | |
| Protected Attributes inherited from ChannelFeed | |
| TemplateParser | $templateParser |
Detailed Description
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 419 of file Feed.php.
References wfTimestamp().
Referenced by outHeader(), and outItem().
◆ 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 455 of file Feed.php.
References getSelfUrl().
Referenced by outHeader().
◆ getSelfUrl()
|
private |
Atom 1.0 requests a self-reference to the feed.
- Returns
- string
Definition at line 463 of file Feed.php.
References $wgRequest, and global.
Referenced by getFeedId(), and outHeader().
◆ outFooter()
| AtomFeed::outFooter | ( | ) |
Outputs the footer for Atom 1.0 feed (basically '\</feed\>').
Reimplemented from ChannelFeed.
Definition at line 491 of file Feed.php.
References print.
◆ outHeader()
| AtomFeed::outHeader | ( | ) |
Outputs a basic header for Atom 1.0 feeds.
Reimplemented from ChannelFeed.
Definition at line 429 of file Feed.php.
References $wgVersion, formatTime(), FeedItem\getDescription(), getFeedId(), FeedItem\getLanguage(), getSelfUrl(), FeedItem\getTitle(), FeedItem\getUrlUnescaped(), global, ChannelFeed\outXmlHeader(), print, PROTO_CURRENT, wfExpandUrl(), wfTimestampNow(), and FeedItem\xmlEncode().
◆ outItem()
| AtomFeed::outItem | ( | $item | ) |
Output a given item.
- Parameters
-
FeedItem $item
Reimplemented from ChannelFeed.
Definition at line 472 of file Feed.php.
References $wgMimeType, formatTime(), global, print, PROTO_CURRENT, wfExpandUrl(), and FeedItem\xmlEncode().
The documentation for this class was generated from the following file:
- includes/Feed.php
