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

Inherited by MediaWiki\Feed\ChannelFeed.

Collaboration diagram for MediaWiki\Feed\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.

	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
string	$author

string	$comments

string	$date

string	$description

bool	$rssIsPermalink = false

string	$title

string	$uniqueId

string	$url

Protected Attributes
UrlUtils	$urlUtils

Detailed Description

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

RSS and other formats).

Definition at line 26 of file FeedItem.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

string	$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 MediaWiki\Feed\ChannelFeed.

Definition at line 61 of file FeedItem.php.

References MediaWiki\Feed\FeedItem\$author, MediaWiki\Feed\FeedItem\$comments, MediaWiki\Feed\FeedItem\$date, MediaWiki\Feed\FeedItem\$description, MediaWiki\Feed\FeedItem\$title, MediaWiki\Feed\FeedItem\$url, and MediaWiki\MediaWikiServices\getInstance().

Member Function Documentation

◆ getAuthor()

MediaWiki\Feed\FeedItem::getAuthor ( )

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

Returns: string

Definition at line 202 of file FeedItem.php.

◆ getAuthorUnescaped()

MediaWiki\Feed\FeedItem::getAuthorUnescaped ( )

Get the author of this item without any escaping.

Returns: string

Definition at line 211 of file FeedItem.php.

◆ getComments()

MediaWiki\Feed\FeedItem::getComments ( )

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

Returns: string

Definition at line 220 of file FeedItem.php.

◆ getCommentsUnescaped()

MediaWiki\Feed\FeedItem::getCommentsUnescaped ( )

Get the comment of this item without any escaping.

Returns: string

Definition at line 229 of file FeedItem.php.

◆ getDate()

MediaWiki\Feed\FeedItem::getDate ( )

Get the date of this item.

Returns: string

Definition at line 193 of file FeedItem.php.

◆ getDescription()

MediaWiki\Feed\FeedItem::getDescription ( )

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

Returns: string

Definition at line 164 of file FeedItem.php.

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

◆ getDescriptionUnescaped()

MediaWiki\Feed\FeedItem::getDescriptionUnescaped ( )

Get the description of this item without any escaping.

Returns: string

Definition at line 173 of file FeedItem.php.

◆ getLanguage()

MediaWiki\Feed\FeedItem::getLanguage ( )

Get the language of this item.

Returns: string

Definition at line 182 of file FeedItem.php.

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

◆ getTitle()

MediaWiki\Feed\FeedItem::getTitle ( )

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

Returns: string

Definition at line 138 of file FeedItem.php.

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

◆ getUniqueID()

MediaWiki\Feed\FeedItem::getUniqueID ( )

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

Returns: string

Definition at line 102 of file FeedItem.php.

◆ getUniqueIdUnescaped()

MediaWiki\Feed\FeedItem::getUniqueIdUnescaped ( )

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

Returns: string|null

Definition at line 114 of file FeedItem.php.

References PROTO_CURRENT.

◆ getUrl()

MediaWiki\Feed\FeedItem::getUrl ( )

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

Returns: string

Definition at line 147 of file FeedItem.php.

◆ getUrlUnescaped()

MediaWiki\Feed\FeedItem::getUrlUnescaped ( )

Get the URL of this item without any escaping.

Returns: string

Definition at line 155 of file FeedItem.php.

References $url.

◆ setUniqueId()

MediaWiki\Feed\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 128 of file FeedItem.php.

◆ stripComment()

static MediaWiki\Feed\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 240 of file FeedItem.php.

◆ xmlEncode()

MediaWiki\Feed\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 81 of file FeedItem.php.

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

◆ xmlEncodeNullable()

MediaWiki\Feed\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)

Definition at line 93 of file FeedItem.php.

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

Member Data Documentation

◆ $author

string MediaWiki\Feed\FeedItem::$author

Definition at line 40 of file FeedItem.php.

Referenced by MediaWiki\Feed\ChannelFeed\__construct(), and MediaWiki\Feed\FeedItem\__construct().

◆ $comments

string MediaWiki\Feed\FeedItem::$comments

Definition at line 46 of file FeedItem.php.

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

◆ $date

string MediaWiki\Feed\FeedItem::$date

Definition at line 37 of file FeedItem.php.

Referenced by MediaWiki\Feed\ChannelFeed\__construct(), and MediaWiki\Feed\FeedItem\__construct().

◆ $description

string MediaWiki\Feed\FeedItem::$description

Definition at line 31 of file FeedItem.php.

Referenced by MediaWiki\Feed\ChannelFeed\__construct(), and MediaWiki\Feed\FeedItem\__construct().

◆ $rssIsPermalink

bool MediaWiki\Feed\FeedItem::$rssIsPermalink = false

Definition at line 49 of file FeedItem.php.

◆ $title

string MediaWiki\Feed\FeedItem::$title

Definition at line 28 of file FeedItem.php.

Referenced by MediaWiki\Feed\ChannelFeed\__construct(), and MediaWiki\Feed\FeedItem\__construct().

◆ $uniqueId

string MediaWiki\Feed\FeedItem::$uniqueId

Definition at line 43 of file FeedItem.php.

◆ $url

string MediaWiki\Feed\FeedItem::$url

Definition at line 34 of file FeedItem.php.

Referenced by MediaWiki\Feed\ChannelFeed\__construct(), and MediaWiki\Feed\FeedItem\__construct().

◆ $urlUtils

UrlUtils MediaWiki\Feed\FeedItem::$urlUtils

protected

Definition at line 51 of file FeedItem.php.

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

includes/Feed/FeedItem.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected 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

◆ $urlUtils