MediaWiki REL1_32
FeedItem Class Reference

A base class for basic support for outputting syndication feeds in RSS and other formats. More...

Inheritance diagram for FeedItem:
Collaboration diagram for FeedItem:

Public Member Functions

 __construct ( $title, $description, $url, $date='', $author='', $comments='')
 
 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.
 

Static Public Member Functions

static stripComment ( $text)
 Quickie hack... strip out wikilinks to more legible form from the comment.
 

Public Attributes

 $author
 
 $comments
 
 $date
 
 $description
 
 $rssIsPermalink = false
 
Title $title
 
 $uniqueId
 
 $url
 

Detailed Description

A base class for basic support for outputting syndication feeds in RSS and other formats.

Definition at line 38 of file Feed.php.

Constructor & Destructor Documentation

◆ __construct()

FeedItem::__construct (   $title,
  $description,
  $url,
  $date = '',
  $author = '',
  $comments = '' 
)
Parameters
string | Title$titleItem's title
string$description
string$urlURL uniquely designating the item.
string$dateItem's date
string$authorAuthor's user name
string$comments

Reimplemented in ChannelFeed.

Definition at line 64 of file Feed.php.

References $author, $comments, $date, $description, $title, $url, and title.

Member Function Documentation

◆ getAuthor()

FeedItem::getAuthor ( )

Get the author of this item; already xml-encoded.

Returns
string

Definition at line 186 of file Feed.php.

References xmlEncode().

◆ getAuthorUnescaped()

FeedItem::getAuthorUnescaped ( )

Get the author of this item without any escaping.

Returns
string

Definition at line 195 of file Feed.php.

References $author.

◆ getComments()

FeedItem::getComments ( )

Get the comment of this item; already xml-encoded.

Returns
string

Definition at line 204 of file Feed.php.

References xmlEncode().

◆ getCommentsUnescaped()

FeedItem::getCommentsUnescaped ( )

Get the comment of this item without any escaping.

Returns
string

Definition at line 213 of file Feed.php.

References $comments.

◆ getDate()

FeedItem::getDate ( )

Get the date of this item.

Returns
string

Definition at line 177 of file Feed.php.

References $date.

◆ getDescription()

FeedItem::getDescription ( )

Get the description of this item; already xml-encoded.

Returns
string

Definition at line 149 of file Feed.php.

References xmlEncode().

Referenced by RSSFeed\outHeader(), and AtomFeed\outHeader().

◆ getDescriptionUnescaped()

FeedItem::getDescriptionUnescaped ( )

Get the description of this item without any escaping.

Returns
string

Definition at line 158 of file Feed.php.

References $description.

◆ getLanguage()

FeedItem::getLanguage ( )

Get the language of this item.

Returns
string

Definition at line 167 of file Feed.php.

References $wgLanguageCode.

Referenced by RSSFeed\outHeader(), and AtomFeed\outHeader().

◆ getTitle()

FeedItem::getTitle ( )

Get the title of this item; already xml-encoded.

Returns
string

Definition at line 123 of file Feed.php.

References title, and xmlEncode().

Referenced by RSSFeed\outHeader(), and AtomFeed\outHeader().

◆ getUniqueID()

FeedItem::getUniqueID ( )

Get the unique id of this item; already xml-encoded.

Returns
string

Definition at line 90 of file Feed.php.

References getUniqueIdUnescaped(), and xmlEncode().

◆ getUniqueIdUnescaped()

FeedItem::getUniqueIdUnescaped ( )

Get the unique id of this item, without any escaping.

Returns
string

Definition at line 101 of file Feed.php.

References PROTO_CURRENT, and wfExpandUrl().

Referenced by getUniqueID().

◆ getUrl()

FeedItem::getUrl ( )

Get the URL of this item; already xml-encoded.

Returns
string

Definition at line 132 of file Feed.php.

References xmlEncode().

◆ getUrlUnescaped()

FeedItem::getUrlUnescaped ( )

Get the URL of this item without any escaping.

Returns
string

Definition at line 140 of file Feed.php.

References $url.

Referenced by RSSFeed\outHeader(), and AtomFeed\outHeader().

◆ setUniqueId()

FeedItem::setUniqueId (   $uniqueId,
  $rssIsPermalink = false 
)

Set the unique id of an item.

Parameters
string$uniqueIdUnique id for the item
bool$rssIsPermalinkSet to true if the guid (unique id) is a permalink (RSS feeds only)

Definition at line 113 of file Feed.php.

References $rssIsPermalink, and $uniqueId.

◆ stripComment()

static FeedItem::stripComment (   $text)
static

Quickie hack... strip out wikilinks to more legible form from the comment.

Parameters
string$textWikitext
Returns
string

Definition at line 223 of file Feed.php.

Referenced by HistoryAction\feedItem(), SpecialNewpages\feedItemDesc(), and ApiFeedContributions\feedItemDesc().

◆ xmlEncode()

FeedItem::xmlEncode (   $string)

Encode $string so that it can be safely embedded in a XML document.

Parameters
string$stringString to encode
Returns
string

Definition at line 80 of file Feed.php.

Referenced by getAuthor(), getComments(), getDescription(), getTitle(), getUniqueID(), getUrl(), RSSFeed\outHeader(), AtomFeed\outHeader(), RSSFeed\outItem(), and AtomFeed\outItem().

Member Data Documentation

◆ $author

FeedItem::$author

Definition at line 48 of file Feed.php.

Referenced by __construct(), ChannelFeed\__construct(), and getAuthorUnescaped().

◆ $comments

FeedItem::$comments

◆ $date

FeedItem::$date

Definition at line 46 of file Feed.php.

Referenced by __construct(), ChannelFeed\__construct(), and getDate().

◆ $description

FeedItem::$description

Definition at line 42 of file Feed.php.

Referenced by __construct(), ChannelFeed\__construct(), and getDescriptionUnescaped().

◆ $rssIsPermalink

FeedItem::$rssIsPermalink = false

Definition at line 54 of file Feed.php.

Referenced by setUniqueId().

◆ $title

Title FeedItem::$title

Definition at line 40 of file Feed.php.

Referenced by __construct(), and ChannelFeed\__construct().

◆ $uniqueId

FeedItem::$uniqueId

Definition at line 50 of file Feed.php.

Referenced by setUniqueId().

◆ $url

FeedItem::$url

Definition at line 44 of file Feed.php.

Referenced by __construct(), ChannelFeed\__construct(), and getUrlUnescaped().


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