MediaWiki master
MediaWiki\Feed\AtomFeed Class Reference

Generate an Atom feed. More...

Inherits MediaWiki\Feed\ChannelFeed.

Collaboration diagram for MediaWiki\Feed\AtomFeed:

Public Member Functions

 outputFooter ( $output)
 Outputs the footer for Atom 1.0 feed (basically '\</feed\>').
 
 outputHeader ( $output)
 Outputs a basic header for Atom 1.0 feeds.
 
 outputItem (FeedItem $item, $output)
 Output a given item.
 
- Public Member Functions inherited from MediaWiki\Feed\ChannelFeed
 __construct ( $title, $description, $url, $date='', $author='', $comments='')
 
 sendHttpHeaders ( $output)
 Setup and send HTTP headers.
 
- 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.
 

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
 
- Protected Member Functions inherited from MediaWiki\Feed\ChannelFeed
 outputXmlHeader ( $output)
 Output the initial XML headers.
 
- Protected Attributes inherited from MediaWiki\Feed\ChannelFeed
TemplateParser $templateParser
 
- Protected Attributes inherited from MediaWiki\Feed\FeedItem
UrlUtils $urlUtils
 

Detailed Description

Generate an Atom feed.

Definition at line 23 of file AtomFeed.php.

Member Function Documentation

◆ outputFooter()

MediaWiki\Feed\AtomFeed::outputFooter ( $output)

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

Generate Footer of the feed.Example: print "</feed>";

Parameters
OutputPage$output
Stability: stable
to override
Since
1.46

Reimplemented from MediaWiki\Feed\ChannelFeed.

Definition at line 102 of file AtomFeed.php.

◆ outputHeader()

MediaWiki\Feed\AtomFeed::outputHeader ( $output)

Outputs a basic header for Atom 1.0 feeds.

Generate Header of the feed.Example: print "<feed>";

Parameters
OutputPage$output
Stability: stable
to override
Since
1.46

Reimplemented from MediaWiki\Feed\ChannelFeed.

Definition at line 42 of file AtomFeed.php.

◆ outputItem()

MediaWiki\Feed\AtomFeed::outputItem ( FeedItem $item,
$output )

Output a given item.

Generate an item.Example: print "<item>...</item>";

Parameters
FeedItem$item
OutputPage$output
Stability: stable
to override
Since
1.46

Reimplemented from MediaWiki\Feed\ChannelFeed.

Definition at line 79 of file AtomFeed.php.


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