Class HTMLCreator

Description

HTMLCreator is a FeedCreator that writes an HTML feed file to a specific location, overriding the createFeed method of the parent FeedCreator.

The HTML produced can be included over http by scripting languages, or serve as the source for an IFrame. All output by this class is embedded in <div></div> tags to enable formatting using CSS.

  • since: 1.7
  • author: Pascal Van Hecke

Located in /includes/feedcreator.class.php (line 1305)

HtmlDescribable
   |
   --FeedCreator
      |
      --HTMLCreator
Direct descendents
Class Description
JSCreator JSCreator is a class that writes a js file to a specific location, overriding the createFeed method of the parent HTMLCreator.
Variable Summary
Method Summary
string createFeed ()
Variables
mixed $contentType = "text/html" (line 1307)

Redefined in descendants as:
mixed $footer (line 1317)

Contains HTML to be output at the end of the feed's html representation.

mixed $header (line 1312)

Contains HTML to be output at the start of the feed's html representation.

mixed $imageAlign = "right" (line 1336)
mixed $openInNewWindow = true (line 1334)

Determines whether the links open in a new window or not.

mixed $separator (line 1323)

Contains HTML to be output between entries. A separator is only used in case of multiple entries.

mixed $stylelessOutput = "" (line 1345)

In case of very simple output you may want to get rid of the style tags,

hence this variable. There's no equivalent on item level, but of course you can add strings to it while iterating over the items ($this->stylelessOutput .= ...) and when it is non-empty, ONLY the styleless output is printed, the rest is ignored in the function createFeed().

mixed $stylePrefix (line 1329)

Used to prefix the stylenames to make sure they are unique and do not clash with stylenames on the users' page.

Inherited Variables

Inherited from FeedCreator

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

Inherited from HtmlDescribable

HtmlDescribable::$descriptionHtmlSyndicated
HtmlDescribable::$descriptionTruncSize
Methods
createFeed (line 1351)

Writes the HTML.

  • return: the scripts's complete text
string createFeed ()

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

Redefined in descendants as:

Inherited Methods

Inherited From FeedCreator

FeedCreator::addItem()
FeedCreator::createFeed()
FeedCreator::iTrunc()
FeedCreator::saveFeed()
FeedCreator::useCached()
FeedCreator::_createAdditionalElements()
FeedCreator::_createGeneratorComment()
FeedCreator::_createStylesheetReferences()

Inherited From HtmlDescribable

HtmlDescribable::getDescription()

Documentation generated on Fri, 4 Mar 2005 13:56:13 +1000 by phpDocumentor 1.3.0RC3