HTMLCreator Class Reference
[FeedCreator]

Inheritance diagram for HTMLCreator:

List of all members.

---

Detailed 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

tags to enable formatting using CSS.

Author:

Pascal Van Hecke

Since:

1.7

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

Public Member Functions
	createFeed ()
	Writes the HTML.
	_generateFilename ()
	Overrrides parent to produce .html extensions.
Public Attributes
	$contentType = "text/html"
	This feed's MIME content type.
	$header
	Contains HTML to be output at the start of the feed's html representation.
	$footer
	Contains HTML to be output at the end of the feed's html representation.
	$separator
	Contains HTML to be output between entries.
	$stylePrefix
	Used to prefix the stylenames to make sure they are unique and do not clash with stylenames on the users' page.
	$openInNewWindow = true
	Determines whether the links open in a new window or not.
	$imageAlign = "right"
	$stylelessOutput = ""
	In case of very simple output you may want to get rid of the style tags, hence this variable.

---

Member Function Documentation

HTMLCreator::_generateFilename (   )

Overrrides parent to produce .html extensions. Returns: string the feed cache filename Since: 1.4 private Reimplemented from FeedCreator. Reimplemented in JSCreator. Definition at line 1455 of file feedcreator.class.php.

HTMLCreator::createFeed (   )

Writes the HTML. Returns: string the scripts's complete text Reimplemented from FeedCreator. Reimplemented in JSCreator. Definition at line 1368 of file feedcreator.class.php. References HtmlDescribable::getDescription(), and FeedCreator::iTrunc().

---

Member Data Documentation

HTMLCreator::$contentType = "text/html"

This feed's MIME content type. Since: 1.4 private Reimplemented from FeedCreator. Reimplemented in JSCreator. Definition at line 1324 of file feedcreator.class.php.

HTMLCreator::$footer

Contains HTML to be output at the end of the feed's html representation. Definition at line 1334 of file feedcreator.class.php.

HTMLCreator::$header

Contains HTML to be output at the start of the feed's html representation. Definition at line 1329 of file feedcreator.class.php.

HTMLCreator::$imageAlign = "right"

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

HTMLCreator::$openInNewWindow = true

Determines whether the links open in a new window or not. Definition at line 1351 of file feedcreator.class.php.

HTMLCreator::$separator

Contains HTML to be output between entries. A separator is only used in case of multiple entries. Definition at line 1340 of file feedcreator.class.php.

HTMLCreator::$stylelessOutput = ""

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(). Definition at line 1362 of file feedcreator.class.php.

HTMLCreator::$stylePrefix

Used to prefix the stylenames to make sure they are unique and do not clash with stylenames on the users' page. Definition at line 1346 of file feedcreator.class.php.

---

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

• lib/feedcreator.class.php

---