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

Collaboration diagram for FeedItem:

[legend]

Public Member Functions
	__construct ( $title, $description, $url, $date='', $author='', $comments='')

	getAuthor ()
	Get the author of this item; already xml-encoded. More...

	getAuthorUnescaped ()
	Get the author of this item without any escaping. More...

	getComments ()
	Get the comment of this item; already xml-encoded. More...

	getCommentsUnescaped ()
	Get the comment of this item without any escaping. More...

	getDate ()
	Get the date of this item. More...

	getDescription ()
	Get the description of this item; already xml-encoded. More...

	getDescriptionUnescaped ()
	Get the description of this item without any escaping. More...

	getLanguage ()
	Get the language of this item. More...

	getTitle ()
	Get the title of this item; already xml-encoded. More...

	getUniqueID ()
	Get the unique id of this item; already xml-encoded. More...

	getUniqueIdUnescaped ()
	Get the unique id of this item, without any escaping. More...

	getUrl ()
	Get the URL of this item; already xml-encoded. More...

	getUrlUnescaped ()
	Get the URL of this item without any escaping. More...

	setUniqueId ( $uniqueId, $rssIsPermalink=false)
	Set the unique id of an item. More...

	xmlEncode ( $string)
	Encode $string so that it can be safely embedded in a XML document. More...

Static Public Member Functions
static	stripComment ( $text)
	Quickie hack... More...

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	$title	Item's title
string	$description
string	$url	URL uniquely designating the item.
string	$date	Item's date
string	$author	Author's user name
string	$comments

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

◆ 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, and LanguageCode\bcp47().

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

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

◆ setUniqueId()

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

Set the unique id of an item.

Parameters

string	$uniqueId	Unique id for the item
bool	$rssIsPermalink	Set 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 $text Wikitext

Returns: string

Definition at line 223 of file Feed.php.

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

◆ xmlEncode()

FeedItem::xmlEncode ( $string )

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

Parameters

string $string String to encode

Returns: string

Definition at line 80 of file Feed.php.

Referenced by getAuthor(), getComments(), getDescription(), getTitle(), getUniqueID(), and getUrl().

Member Data Documentation

◆ $author

FeedItem::$author

Definition at line 48 of file Feed.php.

Referenced by __construct(), and getAuthorUnescaped().

◆ $comments

FeedItem::$comments

Definition at line 52 of file Feed.php.

Referenced by __construct(), and getCommentsUnescaped().

◆ $date

FeedItem::$date

Definition at line 46 of file Feed.php.

Referenced by __construct(), and getDate().

◆ $description

FeedItem::$description

Definition at line 42 of file Feed.php.

Referenced by __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().

◆ $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(), and getUrlUnescaped().

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

includes/Feed.php

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAuthor()

◆ getAuthorUnescaped()

◆ getComments()

◆ getCommentsUnescaped()

◆ getDate()

◆ getDescription()

◆ getDescriptionUnescaped()

◆ getLanguage()

◆ getTitle()

◆ getUniqueID()

◆ getUniqueIdUnescaped()

◆ getUrl()

◆ getUrlUnescaped()

◆ setUniqueId()

◆ stripComment()

◆ xmlEncode()

Member Data Documentation

◆ $author

◆ $comments

◆ $date

◆ $description

◆ $rssIsPermalink

◆ $title

◆ $uniqueId

◆ $url