Class: AtomCreator03

Source Location: /FeedCreator.php

Class Overview

HtmlDescribable
   |
   --FeedCreator
      |
      --AtomCreator03

AtomCreator03 is a FeedCreator that implements the atom specification, as in http://www.intertwingly.net/wiki/pie/FrontPage.

Author(s):

Kai Blankenhorn <kaib@bitfolge.de>, Scott Reynen <scott@randomchaos.com>

Inherited Variables

Class: FeedCreator

FeedCreator::$additionalElements
FeedCreator::$category
FeedCreator::$contentType
FeedCreator::$copyright
FeedCreator::$cssStyleSheet
FeedCreator::$description
FeedCreator::$docs
FeedCreator::$editor
FeedCreator::$editorEmail
FeedCreator::$encoding
FeedCreator::$image
FeedCreator::$items
FeedCreator::$language
FeedCreator::$lastBuildDate
FeedCreator::$link
FeedCreator::$pubDate
FeedCreator::$rating
FeedCreator::$skipDays
FeedCreator::$skipHours
FeedCreator::$syndicationURL
FeedCreator::$title
FeedCreator::$ttl
FeedCreator::$webmaster
FeedCreator::$xslStyleSheet

Class: HtmlDescribable

HtmlDescribable::$descriptionHtmlSyndicated
HtmlDescribable::$descriptionTruncSize

Inherited Methods

Class: FeedCreator

FeedCreator::addItem(): Adds an FeedItem to the feed.
FeedCreator::createFeed(): Builds the feed's text.
FeedCreator::iTrunc(): Truncates a string to a certain length at the most sensible point.
FeedCreator::outputFeed(): Outputs this feed directly to the browser - for on-the-fly feed generation
FeedCreator::saveFeed(): Saves this feed as a file on the local disk. After the file is saved, a redirect header may be sent to redirect the user to the newly created file.
FeedCreator::useCached(): Turns on caching and checks if there is a recent version of this feed in the cache.
FeedCreator::_createAdditionalElements(): Creates a string containing all additional elements specified in $additionalElements.
FeedCreator::_createGeneratorComment(): Creates a comment indicating the generator of this feed.
FeedCreator::_createStylesheetReferences()
FeedCreator::_generateFilename(): Generate a filename for the feed cache file. The result will be $_SERVER["PHP_SELF"] with the extension changed to .xml.
FeedCreator::_redirect()

Class: HtmlDescribable

HtmlDescribable::getDescription(): Returns a formatted description field, depending on descriptionHtmlSyndicated and

Class Details

[line 1335]
AtomCreator03 is a FeedCreator that implements the atom specification, as in http://www.intertwingly.net/wiki/pie/FrontPage.

Please note that just by using AtomCreator03 you won't automatically produce valid atom files. For example, you have to specify either an editor for the feed or an author for every single feed item.

Some elements have not been implemented yet. These are (incomplete list): author URL, item author's email and URL, item contents, alternate links, other link content types than text/html. Some of them may be created with AtomCreator03::additionalElements.

Tags:

author:	Kai Blankenhorn <kaib@bitfolge.de>, Scott Reynen <scott@randomchaos.com>
see:	additionalElements
since:	1.6

[ Top ]

Class Methods

constructor AtomCreator03 [line 1337]

AtomCreator03 AtomCreator03(
)

[ Top ]

method createFeed [line 1342]

void createFeed(
)

Overrides FeedCreator::createFeed() (Builds the feed's text.)

[ Top ]

Documentation generated on Mon, 28 May 2007 16:15:01 +0200 by phpDocumentor 1.3.2