Class TRssFeedDocument

Description
Description | Methods (details)

TRssFeedDocument class

TRssFeedDocument represents an RSS feed. RSS is a family of web feed formats, specified in XML and used for Web syndication. RSS is used by (among other things) news websites, weblogs and podcasting.

Located in /Xml/TRssFeedDocument.php (line 25) 

DOMDocument
   |
   --TFeedDocument
      |
      --TRssFeedDocument
Method Summary
Description | Methods (details)
TRssFeedDocument __construct ([mixed $encoding = null])
void addItem (TRssFeedItem $item)
string getCategory ()
string getCopyright ()
string getDescription ()
An getDocumentation ()
string getFeedContent ()
string getGenerator ()
array getItems ()
string getLanguage ()
The getLastBuildDate ()
string getLink ()
string getManagingEditor ()
string getPublicationDate ()
string getRating ()
array getSkipDays ()
array getSkipHours ()
string getTitle ()
RSS getVersion ()
string getWebMaster ()
void init ()
void setCategory (string $category, string $domain)
void setCloud (TRssFeedCloud $cloud)
void setCopyright (string $copyright)
void setDescription (string $description)
void setDocumentation (string $documentation)
void setGenerator (string $generator)
void setImage (TRssFeedImage $image)
void setLanguage (mixed $language)
void setLastBuildDate (string $date)
void setLink (string $link)
void setManagingEditor (string $managingEditor)
void setPublicationDate (string $pubDate)
void setRating (string $rating)
void setSkipDays (array $days)
void setSkipHours (array $hours)
void setTextInput (TRssFeedTextInput $textInput)
void setTimeToLive (int $ttl)
void setTitle (string $title)
void setVersion (string $version)
void setWebMaster (string $webMaster)
Methods
Description | Methods (details)
Constructor __construct (line 33)

Constructor

  • access: public
TRssFeedDocument __construct ([mixed $encoding = null])
Redefinition of:
TFeedDocument::__construct()
addItem (line 320)
  • access: public
void addItem (TRssFeedItem $item)
getCategory (line 403)
  • return: Category path seperated with forward slash.
  • access: public
string getCategory ()
getCopyright (line 137)
  • return: Copyright notice for content in the channel.
  • access: public
string getCopyright ()
getDescription (line 105)
  • return: Phrase or sentence describing the channel.
  • access: public
string getDescription ()
getDocumentation (line 227)
  • return: URL that references a description of the channel.
  • access: public
An getDocumentation ()
getFeedContent (line 479)
  • return: Feed as XML
  • access: public
string getFeedContent ()
getGenerator (line 428)
  • return: A string indicating the program used to generate the channel.
  • access: public
string getGenerator ()
getItems (line 388)
  • return: A list of TRssItem's
  • access: public
array getItems ()
getLanguage (line 119)
  • return: The language the channel is written in.
  • access: public
string getLanguage ()
getLastBuildDate (line 213)
  • return: last time the channel was modified.
  • access: public
The getLastBuildDate ()
getLink (line 89)
  • return: The URL to the HTML website corresponding to the channel.
  • access: public
string getLink ()
getManagingEditor (line 151)
  • return: Email address for person responsible for editorial content.
  • access: public
string getManagingEditor ()
getPublicationDate (line 193)
  • return: Publication date
  • access: public
string getPublicationDate ()
getRating (line 179)
  • return: The PICS rating for the channel.
  • access: public
string getRating ()
getSkipDays (line 245)
  • return: The days of the week, spelled out in English.
  • access: public
array getSkipDays ()
getSkipHours (line 280)
  • access: public
array getSkipHours ()
getTitle (line 71)
  • return: The name of the channel.
  • access: public
string getTitle ()
getVersion (line 53)
  • return: version
  • access: public
RSS getVersion ()
getWebMaster (line 165)
  • return: Email address for person responsible for technical issues relating to channel.
  • access: public
string getWebMaster ()
init (line 46)
  • access: public
void init ()
setCategory (line 414)

Specify one or more categories that the channel belongs to.

  • access: public
  • since: RSS 2.0
void setCategory (string $category, string $domain)
  • string $category: Category path seperated with forward slash.
  • string $domain: Domain name which the category applies to.
setCloud (line 372)
  • access: public
  • since: RSS 0.92
void setCloud (TRssFeedCloud $cloud)
setCopyright (line 144)
  • access: public
void setCopyright (string $copyright)
  • string $copyright: Copyright notice for content in the channel.
setDescription (line 112)
  • access: public
void setDescription (string $description)
  • string $description: Phrase or sentence describing the channel.
setDocumentation (line 238)

A URL that points to the documentation for the format used in the RSS file. It's probably a pointer to this page. It's for people who might stumble across an RSS file on a Web server 25 years from now and wonder what it is.

  • access: public
void setDocumentation (string $documentation)
  • string $documentation: An URL that references a description of the channel.
setGenerator (line 436)
  • access: public
  • since: RSS 2.0
void setGenerator (string $generator)
  • string $generator: A string indicating the program used to generate the channel.
setImage (line 340)
  • access: public
void setImage (TRssFeedImage $image)
setLanguage (line 130)

The language the channel is written in. This allows aggregators to group all Italian language sites, for example, on a single page. A list of allowable values for this element, as provided by Netscape, is here.

You may also use values defined by the W3C.

  • access: public
void setLanguage (mixed $language)
setLastBuildDate (line 220)
  • access: public
void setLastBuildDate (string $date)
  • string $date: The last time the channel was modified (RFC 822).
setLink (line 98)

The URL to the HTML website corresponding to the channel.

  • access: public
void setLink (string $link)
  • string $link: The URL to the HTML website corresponding to the channel.
setManagingEditor (line 158)
  • access: public
void setManagingEditor (string $managingEditor)
  • string $managingEditor: Email address for person responsible for editorial content.
setPublicationDate (line 206)

The publication date for the content in the channel. For example, the New York Times

publishes on a daily basis, the publication date flips once every 24 hours. That's when the pubDate of the channel changes. All date-times in RSS conform to the Date and Time Specification of RFC 822, with the exception that the year may be expressed with two characters or four characters (four preferred).

  • access: public
void setPublicationDate (string $pubDate)
  • string $pubDate: Publication date
setRating (line 186)
  • access: public
void setRating (string $rating)
  • string $rating: The PICS rating for the channel.
setSkipDays (line 260)
  • access: public
void setSkipDays (array $days)
  • array $days: The days of the week, spelled out in English.
setSkipHours (line 298)

A list of hour's indicating the hours in the day, GMT, when the channel is unlikely to be updated. If not set, the channel is assumed to be updated hourly.

  • access: public
void setSkipHours (array $hours)
  • array $hours
setTextInput (line 356)
  • access: public
void setTextInput (TRssFeedTextInput $textInput)
  • TRssFeedTextInput $textInput: A small text box and a Submit button to associate with a CGI application.
setTimeToLive (line 451)

ttl stands for time to live. It's a number of minutes that indicates how long a channel can be cached before refreshing from the source.

  • access: public
  • since: RSS 2.0
void setTimeToLive (int $ttl)
  • int $ttl: Number of minutes that channel can be cached.
setTitle (line 82)

The name of the channel. It's how people refer to your service. If you have an HTML website that contains the same information as your RSS file, the title of your channel should be the same as the title of your website.

  • access: public
void setTitle (string $title)
  • string $title: The name of the channel.
setVersion (line 60)
  • access: public
void setVersion (string $version)
  • string $version: RSS version
setWebMaster (line 172)
  • access: public
void setWebMaster (string $webMaster)
  • string $webMaster: Email address for person responsible for technical issues relating to channel.

Inherited Methods

Inherited From TFeedDocument

TFeedDocument::__construct()
TFeedDocument::getEncoding()
TFeedDocument::setEncoding()

Documentation generated on Sun, 14 Jan 2007 21:44:11 -0500 by phpDocumentor 1.3.0RC4