FeedItem Class Reference

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

Inheritance diagram for FeedItem:

List of all members.

Public Member Functions
	__construct ($title, $description, $url, $date= '', $author= '', $comments= '')
	Constructor.
	getAuthor ()
	Get the author of this item; already xml-encoded.
	getComments ()
	Get the comment of this item; already xml-encoded.
	getDate ()
	Get the title of this item.
	getDescription ()
	Get the description of this item; already xml-encoded.
	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.
	getUrl ()
	Get the URL of this item; already xml-encoded.
	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...
Public Attributes
	$author
	$comments
	$date
	$description
	$rssIsPermalink = false
	$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

FeedItem::__construct	(	$	title,
		$	description,
		$	url,
		$	date = '',
		$	author = '',
		$	comments = ''
	)

Constructor.

Parameters:

$title	String|Title Item's title
$description	String
$url	String: URL uniquely designating the item.
$date	String: Item's date
$author	String: Author's user name
$comments	String

Definition at line 62 of file Feed.php.

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

---

Member Function Documentation

FeedItem::getAuthor

(

)

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

Returns:

String

Definition at line 157 of file Feed.php.

References xmlEncode().

Here is the call graph for this function:

FeedItem::getComments

(

)

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

Returns:

String

Definition at line 166 of file Feed.php.

References xmlEncode().

Here is the call graph for this function:

FeedItem::getDate

(

)

Get the title of this item.

Returns:

String

Definition at line 148 of file Feed.php.

FeedItem::getDescription

(

)

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

Returns:

String

Definition at line 129 of file Feed.php.

References xmlEncode().

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

Here is the call graph for this function:

Here is the caller graph for this function:

FeedItem::getLanguage

(

)

Get the language of this item.

Returns:

String

Definition at line 138 of file Feed.php.

References $wgLanguageCode.

Referenced by RSSFeed\outHeader().

Here is the caller graph for this function:

FeedItem::getTitle

(

)

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

Returns:

String

Definition at line 111 of file Feed.php.

References xmlEncode().

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

Here is the call graph for this function:

Here is the caller graph for this function:

FeedItem::getUniqueId

(

)

Get the unique id of this item.

Returns:

String

Definition at line 89 of file Feed.php.

References xmlEncode().

Here is the call graph for this function:

FeedItem::getUrl

(

)

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

Returns:

String

Definition at line 120 of file Feed.php.

References xmlEncode().

Referenced by RSSFeed\outHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

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

set the unique id of an item

Parameters:

$uniqueId	String: unique id for the item
$rssIsPermalink	Boolean: set to true if the guid (unique id) is a permalink (RSS feeds only)

Definition at line 101 of file Feed.php.

References $rssIsPermalink, and $uniqueId.

static FeedItem::stripComment

(

$

text

)

[static]

Quickie hack...

strip out wikilinks to more legible form from the comment.

Parameters:

$text

String: wikitext

Returns:

String

Definition at line 176 of file Feed.php.

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

Here is the caller graph for this function:

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 78 of file Feed.php.

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

Here is the caller graph for this function:

---

Member Data Documentation

FeedItem::$author

Definition at line 47 of file Feed.php.

Referenced by __construct().

FeedItem::$comments

Definition at line 49 of file Feed.php.

Referenced by __construct().

FeedItem::$date

Definition at line 46 of file Feed.php.

Referenced by __construct().

FeedItem::$description

Definition at line 44 of file Feed.php.

Referenced by __construct().

FeedItem::$rssIsPermalink = false

Definition at line 50 of file Feed.php.

Referenced by setUniqueId().

FeedItem::$title

Definition at line 42 of file Feed.php.

Referenced by __construct().

FeedItem::$uniqueId

Definition at line 48 of file Feed.php.

Referenced by setUniqueId().

FeedItem::$url

Definition at line 45 of file Feed.php.

Referenced by __construct().

---

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

• includes/Feed.php