UniversalFeedCreator Class Reference
[FeedCreator]

Inheritance diagram for UniversalFeedCreator:

List of all members.

---

Detailed Description

UniversalFeedCreator lets you choose during runtime which format to build.

For general usage of a feed class, see the FeedCreator class below or the example above.

Since:

1.3

Author:

Kai Blankenhorn <kaib@bitfolge.de>

Definition at line 341 of file feedcreator.class.php.

Public Member Functions
	_setFormat ($format)
	createFeed ($format="RSS0.91")
	Creates a syndication feed based on the items previously added.
	saveFeed ($format="RSS0.91", $filename="", $displayContents=true)
	Saves this feed as a file on the local disk.
	useCached ($format="RSS0.91", $filename="", $timeout=3600)
	Turns on caching and checks if there is a recent version of this feed in the cache.
Public Attributes
	$_feed

---

Member Function Documentation

UniversalFeedCreator::_setFormat (  $  format  )

Definition at line 344 of file feedcreator.class.php.

UniversalFeedCreator::createFeed (  $  format = "RSS0.91"  )

Creates a syndication feed based on the items previously added. See also: FeedCreator::addItem() Parameters: string  format format the feed should comply to. Valid values are: "PIE0.1", "mbox", "RSS0.91", "RSS1.0", "RSS2.0", "OPML", "ATOM0.3", "HTML", "JS" Returns: string the contents of the feed. Definition at line 416 of file feedcreator.class.php.

UniversalFeedCreator::saveFeed (  $  format = "RSS0.91", $  filename = "", $  displayContents = true )

Saves this feed as a file on the local disk. After the file is saved, an HTTP redirect header may be sent to redirect the use to the newly created file. Since: 1.4 Parameters: string  format format the feed should comply to. Valid values are: "PIE0.1" (deprecated), "mbox", "RSS0.91", "RSS1.0", "RSS2.0", "OPML", "ATOM", "ATOM0.3", "HTML", "JS" string  filename optional the filename where a recent version of the feed is saved. If not specified, the filename is $_SERVER["PHP_SELF"] with the extension changed to .xml (see _generateFilename()). boolean  displayContents optional send the content of the file or not. If true, the file will be sent in the body of the response. Definition at line 433 of file feedcreator.class.php.

UniversalFeedCreator::useCached (  $  format = "RSS0.91", $  filename = "", $  timeout = 3600 )

Turns on caching and checks if there is a recent version of this feed in the cache. If there is, an HTTP redirect header is sent. To effectively use caching, you should create the FeedCreator object and call this method before anything else, especially before you do the time consuming task to build the feed (web fetching, for example). Parameters: string  format format the feed should comply to. Valid values are: "PIE0.1" (deprecated), "mbox", "RSS0.91", "RSS1.0", "RSS2.0", "OPML", "ATOM0.3". filename  string optional the filename where a recent version of the feed is saved. If not specified, the filename is $_SERVER["PHP_SELF"] with the extension changed to .xml (see _generateFilename()). timeout  int optional the timeout in seconds before a cached version is refreshed (defaults to 3600 = 1 hour) Definition at line 451 of file feedcreator.class.php.

---

Member Data Documentation

UniversalFeedCreator::$_feed

Definition at line 342 of file feedcreator.class.php.

---

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

• lib/feedcreator.class.php

---