|
MediaWiki master
|
Class to support the outputting of syndication feeds in Atom and RSS format. More...
Inherits MediaWiki\Feed\FeedItem.
Inherited by MediaWiki\Feed\AtomFeed, and MediaWiki\Feed\RSSFeed.

Public Member Functions | |
| __construct ( $title, $description, $url, $date='', $author='', $comments='') | |
| httpHeaders () | |
| Setup and send HTTP headers. | |
| outFooter () | |
| Generate Footer of the feed. | |
| outHeader () | |
| Generate Header of the feed. | |
| outItem ( $item) | |
| Generate an item. | |
Public Member Functions inherited from MediaWiki\Feed\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. | |
| xmlEncodeNullable (?string $string) | |
Encode $string so that it can be safely embedded in a XML document, returning null if $string was null. | |
Protected Member Functions | |
| outXmlHeader () | |
| Output the initial XML headers. | |
Protected Attributes | |
| TemplateParser | $templateParser |
Protected Attributes inherited from MediaWiki\Feed\FeedItem | |
| UrlUtils | $urlUtils |
Additional Inherited Members | |
Static Public Member Functions inherited from MediaWiki\Feed\FeedItem | |
| static | stripComment ( $text) |
| Quickie hack... strip out wikilinks to more legible form from the comment. | |
Public Attributes inherited from MediaWiki\Feed\FeedItem | |
| string | $author |
| string | $comments |
| string | $date |
| string | $description |
| bool | $rssIsPermalink = false |
| string | $title |
| string | $uniqueId |
| string | $url |
Class to support the outputting of syndication feeds in Atom and RSS format.
Definition at line 23 of file ChannelFeed.php.
| MediaWiki\Feed\ChannelFeed::__construct | ( | $title, | |
| $description, | |||
| $url, | |||
| $date = '', | |||
| $author = '', | |||
| $comments = '' ) |
| string | $title | Feed's title |
| string | $description | |
| string | $url | URL uniquely designating the feed. |
| string | $date | Feed's date |
| string | $author | Author's user name |
| string | $comments |
Reimplemented from MediaWiki\Feed\FeedItem.
Definition at line 38 of file ChannelFeed.php.
References MediaWiki\Feed\FeedItem\$author, MediaWiki\Feed\FeedItem\$comments, MediaWiki\Feed\FeedItem\$date, MediaWiki\Feed\FeedItem\$description, MediaWiki\Feed\FeedItem\$title, and MediaWiki\Feed\FeedItem\$url.
| MediaWiki\Feed\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 81 of file ChannelFeed.php.
References $wgOut, MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\MainConfigNames\VaryOnXFP.
Referenced by MediaWiki\Feed\ChannelFeed\outXmlHeader().
|
abstract |
Generate Footer of the feed.
Reimplemented in MediaWiki\Feed\AtomFeed, and MediaWiki\Feed\RSSFeed.
|
abstract |
Generate Header of the feed.
Reimplemented in MediaWiki\Feed\AtomFeed, and MediaWiki\Feed\RSSFeed.
|
abstract |
Generate an item.
| FeedItem | $item |
Reimplemented in MediaWiki\Feed\AtomFeed, and MediaWiki\Feed\RSSFeed.
|
protected |
Output the initial XML headers.
Definition at line 128 of file ChannelFeed.php.
References MediaWiki\Feed\ChannelFeed\httpHeaders().
Referenced by MediaWiki\Feed\AtomFeed\outHeader(), and MediaWiki\Feed\RSSFeed\outHeader().
|
protected |
Definition at line 26 of file ChannelFeed.php.