A base class for outputting syndication feeds (e.g. More...

Inheritance diagram for FeedItem:

[legend]

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.

	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.

	xmlEncodeNullable (?string $string)
	Encode $string so that it can be safely embedded in a XML document, returning `null` if $string was `null`.

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 outputting syndication feeds (e.g.

RSS and other formats).

Definition at line 36 of file FeedItem.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

Reimplemented in ChannelFeed.

Definition at line 62 of file FeedItem.php.

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

Member Function Documentation

◆ getAuthor()

FeedItem::getAuthor ( )

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

Returns: string

Definition at line 198 of file FeedItem.php.

◆ getAuthorUnescaped()

FeedItem::getAuthorUnescaped ( )

Get the author of this item without any escaping.

Returns: string

Definition at line 207 of file FeedItem.php.

◆ getComments()

FeedItem::getComments ( )

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

Returns: string

Definition at line 216 of file FeedItem.php.

◆ getCommentsUnescaped()

FeedItem::getCommentsUnescaped ( )

Get the comment of this item without any escaping.

Returns: string

Definition at line 225 of file FeedItem.php.

◆ getDate()

FeedItem::getDate ( )

Get the date of this item.

Returns: string

Definition at line 189 of file FeedItem.php.

◆ getDescription()

FeedItem::getDescription ( )

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

Returns: string

Definition at line 160 of file FeedItem.php.

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

◆ getDescriptionUnescaped()

FeedItem::getDescriptionUnescaped ( )

Get the description of this item without any escaping.

Returns: string

Definition at line 169 of file FeedItem.php.

◆ getLanguage()

FeedItem::getLanguage ( )

Get the language of this item.

Returns: string

Definition at line 178 of file FeedItem.php.

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

◆ getTitle()

FeedItem::getTitle ( )

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

Returns: string

Definition at line 134 of file FeedItem.php.

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

◆ getUniqueID()

FeedItem::getUniqueID ( )

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

Returns: string

Definition at line 101 of file FeedItem.php.

◆ getUniqueIdUnescaped()

FeedItem::getUniqueIdUnescaped ( )

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

Returns: string

Definition at line 112 of file FeedItem.php.

References PROTO_CURRENT, and wfExpandUrl().

◆ getUrl()

FeedItem::getUrl ( )

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

Returns: string

Definition at line 143 of file FeedItem.php.

◆ getUrlUnescaped()

FeedItem::getUrlUnescaped ( )

Get the URL of this item without any escaping.

Returns: string

Definition at line 151 of file FeedItem.php.

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

◆ 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 124 of file FeedItem.php.

◆ 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 235 of file FeedItem.php.

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

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

◆ xmlEncodeNullable()

FeedItem::xmlEncodeNullable ( ?string $string )

Encode $string so that it can be safely embedded in a XML document, returning null if $string was null.

Since: 1.44 (also backported to 1.39.12, 1.42.6 and 1.43.1)

Parameters

string | null $string

Returns: string|null

Definition at line 93 of file FeedItem.php.

References xmlEncode().

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

Member Data Documentation

◆ $author

FeedItem::$author

Definition at line 46 of file FeedItem.php.

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

◆ $comments

FeedItem::$comments

Definition at line 50 of file FeedItem.php.

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

◆ $date

FeedItem::$date

Definition at line 44 of file FeedItem.php.

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

◆ $description

FeedItem::$description

Definition at line 40 of file FeedItem.php.

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

◆ $rssIsPermalink

FeedItem::$rssIsPermalink = false

Definition at line 52 of file FeedItem.php.

◆ $title

Title FeedItem::$title

Definition at line 38 of file FeedItem.php.

Referenced by ChannelFeed\__construct().

◆ $uniqueId

FeedItem::$uniqueId

Definition at line 48 of file FeedItem.php.

◆ $url

FeedItem::$url

Definition at line 42 of file FeedItem.php.

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

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

includes/changes/FeedItem.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()

◆ xmlEncodeNullable()

Member Data Documentation

◆ $author

◆ $comments

◆ $date

◆ $description

◆ $rssIsPermalink

◆ $title

◆ $uniqueId

◆ $url