Docs For Class RSSItem

Description

This class represents an item in an RSS feed

version: $Id: RSSAction.class.php,v 1.4 2007/09/19 14:04:41 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 8/7/06

Located in /polyphony/main/library/AbstractActions/RSSAction.class.php (line 508)

Variable Summary

array $_categories

array $_enclosures

Method Summary

void addCategory (string $category, [mixed $domain = '_no_domain_'])

void addEnclosure (string $url, integer $length, string $mimeType)

string getDescription ()

object or getPubDate ()

void prependCategory (string $category, [mixed $domain = '_no_domain_'])

void setAuthor (string $name, [optional $email = 'nobody@example.net'])

void setCommentsLink (string $commentsLink)

void setDescription (string $description)

void setGUID (string $guid, [optional $isPermaLink = true])

void setLink (string $link, [optional $isGUID = true])

void setPubDate (object DateAndTime $pubDate)

void setSource (string $sourceTitle, string $sourceLink)

void setTitle (string $title)

void write ()

Variables

array $_categories = array() (line 515)

since: 8/8/06
access: private

array $_enclosures (line 522)

since: 8/9/06
access: private

Methods

addCategory (line 668)

Optional: Add a category category

since: 8/7/06
access: public

void addCategory (string $category, [mixed $domain = '_no_domain_'])

string $category: category

addEnclosure (line 734)

Optional: Add an enclosure. As of this writing the RSS 2.0 spec does not allow multiple enclosures. Some aggregators however, support them anyway and the one's I've (Adam) tested in simply ignore the extra enclosures.

Add multiple enclosures at your own risk.

since: 8/7/06
access: public

void addEnclosure (string $url, integer $length, string $mimeType)

string $url
integer $length
string $mimeType

getDescription (line 569)

Answer the description

since: 8/9/06
access: public

string getDescription ()

getPubDate (line 617)

Answer the PubDate

return: null
since: 8/8/06
access: public

object or getPubDate ()

prependCategory (line 683)

Optional: Add a category to the beginning of the list

since: 8/9/06
access: public

void prependCategory (string $category, [mixed $domain = '_no_domain_'])

string $category: category

setAuthor (line 635)

Optional: Set the author name and email

since: 8/7/06
access: public

void setAuthor (string $name, [optional $email = 'nobody@example.net'])

string $name
optional $email: string $email

setCommentsLink (line 698)

Optional: Set comments URL

since: 8/7/06
access: public

void setCommentsLink (string $commentsLink)

string $commentsLink

setDescription (line 554)

Required: Set the description

since: 8/7/06
access: public

void setDescription (string $description)

string $description

setGUID (line 652)

Optional: Set the GUID and isPermaLink

since: 8/7/06
access: public

void setGUID (string $guid, [optional $isPermaLink = true])

string $guid
optional $isPermaLink: boolean $isPermaLink

setLink (line 586)

Optional: Set the link, if it is the GUID, then the GUID will be set to the link.

since: 8/7/06
access: public

void setLink (string $link, [optional $isGUID = true])

string $link
optional $isGUID: boolean $isGUID

setPubDate (line 604)

Optional: Set the publish date

since: 8/7/06
access: public

void setPubDate (object DateAndTime $pubDate)

object DateAndTime $pubDate

setSource (line 713)

Optional: Set source

since: 8/7/06
access: public

void setSource (string $sourceTitle, string $sourceLink)

string $sourceTitle
string $sourceLink

setTitle (line 539)

Required: Set the title

since: 8/7/06
access: public

void setTitle (string $title)

string $title

write (line 757)

print out the item XML

since: 8/7/06
access: public

void write ()