rss
[ class tree: rss ] [ index: rss ] [ all elements ]

Class: HTMLCreator

Source Location: d:\website\PhpDocumentor\/rss/feedcreator.class.php

Class Overview

HtmlDescribable
   |
   --FeedCreator
      |
      --HTMLCreator



Author(s):

  • Pascal Van Hecke

Variables

Methods


Child classes:

Inherited Variables

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

Class: HtmlDescribable

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

Class Details

[line 1270]


Tags:

since:  1.7
author:  Pascal Van Hecke


[ Top ]


Class Variables

$contentType =  "text/html"

[line 1272]


Type:   mixed


[ Top ]

$footer =

[line 1282]

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


Type:   mixed


[ Top ]

$header =

[line 1277]

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


Type:   mixed


[ Top ]

$imageAlign = "right"

[line 1301]


Type:   mixed


[ Top ]

$openInNewWindow =  true

[line 1299]

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


Type:   mixed


[ Top ]

$separator =

[line 1288]

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


Type:   mixed


[ Top ]

$stylelessOutput = ""

[line 1310]

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 1294]

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 1316]

string createFeed( )

Writes the HTML.



Tags:

return:  the scripts's complete text


Overridden in child classes as:

JSCreator::createFeed()
writes the javascript

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

[ Top ]


Documentation generated on Thu, 15 Feb 2007 20:39:10 +0000 by phpDocumentor 1.3.0