MediaWiki  1.34.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, 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...
 

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...
 

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.

◆ outHeader()

AtomFeed::outHeader ( )

Outputs a basic header for Atom 1.0 feeds.

Definition at line 46 of file AtomFeed.php.

References $wgVersion, formatTime(), getFeedId(), getSelfUrl(), getTitle(), PROTO_CURRENT, wfExpandUrl(), and wfTimestampNow().

◆ outItem()

AtomFeed::outItem (   $item)

Output a given item.

Parameters
FeedItem$item

Definition at line 89 of file AtomFeed.php.

References $wgMimeType, formatTime(), PROTO_CURRENT, and wfExpandUrl().


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