Docs For Class RSSAction

Description

<##>

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 26)

Action
   |
   --ForceAuthAction
      |
      --RSSAction

Direct descendents

Class	Description
browse_rssAction	<##>

Variable Summary

array $_categories

string $_description

string $_generator

array $_items

string $_link

array $_skipDays

array $_skipHours

string $_title

Method Summary

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

object RSSItem addItem (object RSSItem $item)

void execute ()

mixed getLatestItemDate ()

void printRSSTimestamp (object DateAndTime $timestamp)

void setCopyright (string $copyright)

void setDescription (string $description)

void setImage (string $imageURL, [mixed $imageHeight = null], [mixed $imageWidth = null], [string $imageTitle = null], [mixed $imageLink = null], [mixed $imageDescription = null])

void setLastBuildDate (object DateAndTime $lastBuildDate)

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

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

void setPubDate (object DateAndTime $pubDate)

void setTitle (string $title)

void setTTL (integer $minutes)

void write ()

Variables

array $_categories = array() (line 63)

since: 8/8/06
access: private

string $_description (line 56)

since: 8/7/06
access: private

string $_generator = 'Harmoni Application Framework' (line 70)

since: 8/7/06
access: private

array $_items = array() (line 35)

var: Items in the feed
since: 8/7/06
access: private

string $_link = 'http://www.example.net/' (line 49)

since: 8/7/06
access: private

array $_skipDays = array() (line 84)

since: 8/8/06
access: private

array $_skipHours = array() (line 77)

since: 8/8/06
access: private

string $_title = 'Untitled' (line 42)

since: 8/7/06
access: private

Methods

addCategory (line 246)

Optional: Set the category

since: 8/7/06
access: public

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

string $category: category

addItem (line 116)

Add an item to this feed

return: The item added.
since: 8/7/06
access: public

object RSSItem addItem (object RSSItem $item)

object RSSItem $item

execute (line 94)

Build the content for this action

since: 4/26/05
access: public

void execute ()

Redefinition of:

Action::execute(): Execute this action.

getLatestItemDate (line 455)

Get the latested Item-date

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

mixed getLatestItemDate ()

printRSSTimestamp (line 483)

Print a timestamp in RSS form

since: 8/7/06
access: public

void printRSSTimestamp (object DateAndTime $timestamp)

object DateAndTime $timestamp

setCopyright (line 232)

Optional: Set the copyright notice

since: 8/7/06
access: public

void setCopyright (string $copyright)

string $copyright

setDescription (line 167)

Required: Set the description

since: 8/7/06
access: public

void setDescription (string $description)

string $description

setImage (line 286)

Optional: Specifies a GIF, JPEG or PNG image that can be displayed with the channel.

since: 8/7/06
access: public

void setImage (string $imageURL, [mixed $imageHeight = null], [mixed $imageWidth = null], [string $imageTitle = null], [mixed $imageLink = null], [mixed $imageDescription = null])

string $imageURL
string $imageTitle

setLastBuildDate (line 201)

Optional: Set the lastBuildDate

since: 8/7/06
access: public

void setLastBuildDate (object DateAndTime $lastBuildDate)

object DateAndTime $lastBuildDate

setLink (line 149)

Required: 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 = FALSE])

string $link
optional $isGUID: boolean $isGUID

setManagingEditor (line 216)

Optional: Set the managingEditor name and email

since: 8/7/06
access: public

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

string $name
optional $email: string $email

setPubDate (line 187)

Optional: Set the publish date

since: 8/7/06
access: public

void setPubDate (object DateAndTime $pubDate)

object DateAndTime $pubDate

setTitle (line 133)

Required: Set the title

since: 8/7/06
access: public

void setTitle (string $title)

string $title

setTTL (line 270)

Optional: Set the time to live, It's a number of minutes that indicates how long a channel can be cached before refreshing from the source.

since: 8/7/06
access: public

void setTTL (integer $minutes)

integer $minutes

write (line 324)

Send the Content headers and write the feed, then exit.

since: 8/7/06
access: public

void write ()

Inherited Methods

Inherited From ForceAuthAction

ForceAuthAction::authenticate()
ForceAuthAction::getCancelFunction()
ForceAuthAction::getRelm()
ForceAuthAction::isAuthenticated()
ForceAuthAction::isAuthorizedToExecute()
ForceAuthAction::isExecutionAuthorized()

Inherited From Action

Action::execute()
Action::getHeadingText()
Action::getUnauthorizedMessage()
Action::isAuthorizedToExecute()
Action::requestedAction()
Action::requestedModule()