FeedItem Class Reference
[Feed]

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

Inherited by ChannelFeed.

List of all members.

Public Member Functions

 __construct ($Title, $Description, $Url, $Date= '', $Author= '', $Comments= '')
 #@-
 xmlEncode ($string)
 Encode $string so that it can be safely embedded in a XML document.
 getUniqueId ()
 Get the unique id of this item.
 setUniqueId ($uniqueId, $RSSisPermalink=False)
 set the unique id of an item
 getTitle ()
 Get the title of this item; already xml-encoded.
 getUrl ()
 Get the URL of this item; already xml-encoded.
 getDescription ()
 Get the description of this item; already xml-encoded.
 getLanguage ()
 Get the language of this item.
 getDate ()
 Get the title of this item.
 getAuthor ()
 Get the author of this item; already xml-encoded.
 getComments ()
 Get the comment of this item; already xml-encoded.

Static Public Member Functions

static stripComment ($text)
 Quickie hack.

Public Attributes

 $Title = 'Wiki'
 $Description = ''
 $Url = ''
 $Date = ''
 $Author = ''
 $UniqueId = ''
 $RSSIsPermalink


Detailed Description

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

Definition at line 36 of file Feed.php.


Constructor & Destructor Documentation

FeedItem::__construct ( Title,
Description,
Url,
Date = '',
Author = '',
Comments = '' 
)

#@-

Constructor

Parameters:
$Title String: 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 60 of file Feed.php.

References $Author, $Date, $Description, $Title, and $Url.


Member Function Documentation

FeedItem::getAuthor (  ) 

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

Returns:
String

Definition at line 156 of file Feed.php.

References xmlEncode().

FeedItem::getComments (  ) 

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

Returns:
String

Definition at line 165 of file Feed.php.

References xmlEncode().

FeedItem::getDate (  ) 

Get the title of this item.

Returns:
String

Definition at line 147 of file Feed.php.

FeedItem::getDescription (  ) 

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

Returns:
String

Definition at line 128 of file Feed.php.

References xmlEncode().

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

FeedItem::getLanguage (  ) 

Get the language of this item.

Returns:
String

Definition at line 137 of file Feed.php.

References $wgContLanguageCode.

Referenced by RSSFeed::outHeader().

FeedItem::getTitle (  ) 

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

Returns:
String

Definition at line 110 of file Feed.php.

References xmlEncode().

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

FeedItem::getUniqueId (  ) 

Get the unique id of this item.

Returns:
String

Definition at line 88 of file Feed.php.

References xmlEncode().

FeedItem::getUrl (  ) 

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

Returns:
String

Definition at line 119 of file Feed.php.

References xmlEncode().

Referenced by RSSFeed::outHeader().

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

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

Referenced by HistoryPage::feedItem(), SpecialNewpages::feedItemDesc(), and SpecialContributions::feedItemDesc().

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

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


Member Data Documentation

FeedItem::$Author = ''

Definition at line 45 of file Feed.php.

Referenced by __construct().

FeedItem::$Date = ''

Definition at line 44 of file Feed.php.

Referenced by __construct().

FeedItem::$Description = ''

Definition at line 42 of file Feed.php.

Referenced by __construct().

FeedItem::$RSSIsPermalink

Definition at line 47 of file Feed.php.

FeedItem::$Title = 'Wiki'

Definition at line 41 of file Feed.php.

Referenced by __construct().

FeedItem::$UniqueId = ''

Definition at line 46 of file Feed.php.

FeedItem::$Url = ''

Definition at line 43 of file Feed.php.

Referenced by __construct().


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

Generated on Sat Apr 30 22:57:37 2011 for MediaWiki by  doxygen 1.5.9