Class: HTMLCreator

Source Location: /FeedCreator.php

Class Overview

HtmlDescribable
   |
   --FeedCreator
      |
      --HTMLCreator

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

Author(s):

Pascal Van Hecke

Child classes:

JSCreator: JSCreator is a class that writes a js file to a specific location, overriding the createFeed method of the parent HTMLCreator.

Inherited Variables

Class: FeedCreator

FeedCreator::$additionalElements
FeedCreator::$category
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 1547]
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.

Tags:

author:	Pascal Van Hecke
since:	1.7

[ Top ]

Class Variables

$contentType = "text/html"

[line 1549]

Type:	mixed
Overrides:	Array

[ Top ]

$footer =

[line 1559]

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

Type:

mixed

[ Top ]

$header =

[line 1554]

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

Type:

mixed

[ Top ]

$imageAlign = "right"

[line 1578]

Type:

mixed

[ Top ]

$openInNewWindow = true

[line 1576]

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

Type:

mixed

[ Top ]

$separator =

[line 1565]

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

Type:

mixed

[ Top ]

$stylelessOutput = ""

[line 1587]

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().

Type:

mixed

[ Top ]

$stylePrefix =

[line 1571]

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

Type:

mixed

[ Top ]

Class Methods

method createFeed [line 1593]

string createFeed(
)

Writes the HTML.

method _generateFilename [line 1680]

string _generateFilename(
)

Overrrides parent to produce .html extensions

Tags:

return:	the feed cache filename
since:	1.4
access:	private

Overridden in child classes as:

JSCreator::_generateFilename(): Overrrides parent to produce .js extensions

Overrides FeedCreator::_generateFilename() (Generate a filename for the feed cache file. The result will be $_SERVER["PHP_SELF"] with the extension changed to .xml.)

[ Top ]

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