MediaWiki  1.30.0
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. More...
 
if( $item->getDate()) print $item getDescription() if( $item->getAuthor()) 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...
 

Private Member Functions

print $this getFeedId() print $this getTitle() print wfExpandUrl($this->getSelfUrl(), PROTO_CURRENT) print wfExpandUrl($this->getUrl(), PROTO_CURRENT) print $this formatTime(wfTimestampNow()) print $this getDescription() print $wgVersion 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...
 

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()

print $this getFeedId () print $this getTitle () print wfExpandUrl ( $this->getSelfUrl(), PROTO_CURRENT ) print wfExpandUrl ( $this->getUrl(), PROTO_CURRENT ) print $this formatTime ( wfTimestampNow() ) print $this getDescription () print $wgVersion 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, and global.

Referenced by getFeedId().

◆ outFooter()

if ($item->getDate()) print $item getDescription () if ($item->getAuthor()) AtomFeed::outFooter ( )

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

Definition at line 425 of file Feed.php.

References php.

◆ outHeader()

AtomFeed::outHeader ( )

Outputs a basic header for Atom 1.0 feeds.

Definition at line 358 of file Feed.php.

References $wgVersion, formatTime(), getFeedId(), global, href, link, outXmlHeader(), php, title, type, and wfTimestampNow().

◆ outItem()

AtomFeed::outItem (   $item)

Output a given item.

Parameters
FeedItem$item

Definition at line 401 of file Feed.php.

References $wgMimeType, formatTime(), MediaWiki\getTitle(), global, href, link, name, php, title, and type.


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