Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

 Class JDocumentFeed

Description

DocumentFeed class, provides an easy interface to parse and display any feed document

Located in /joomla/document/feed/feed.php (line 27)

Class JObject   (Subpackage Base)

Abstract class JDocument
   
   Class JDocumentFeed   (Subpackage Document)
Variable Summary
Variable string $category
Variable string $copyright
Variable string $docs
Variable string $editor
Variable string $editorEmail
Variable object $image
Variable array $items
Variable string $pubDate
Variable string $rating
Variable string $skipDays
Variable string $skipHours
Variable string $ttl
Variable string $webmaster
Method Summary
Constructor JDocumentFeed __construct ([array $options = array()])
Method void addItem ( &$item, object JFeedItem $item)
Method The render ([boolean $cache = false], [array $params = array()])
Variables
string $category = "" (line 125)

Category feed element

optional

  • access: public
string $copyright = "" (line 57)

Copyright feed elememnt

optional

  • access: public
string $docs = "" (line 95)

Docs feed element

  • access: public
string $editor = "" (line 87)

Editor feed element

optional

  • access: public
string $editorEmail = "" (line 105)

Editor email feed element

optional

  • access: public
object $image = null (line 47)

Image feed element

optional

  • access: public
array $items = array() (line 173)

The feed items collection

  • access: public
string $lastBuildDate = "" (line 77)

Lastbuild date feed element

optional

  • access: public
string $pubDate = "" (line 67)

Published date feed element

optional

  • access: public
string $rating = "" (line 145)

Rating feed element

optional

  • access: public
string $skipDays = "" (line 165)

Skipdays feed element

optional

  • access: public
string $skipHours = "" (line 155)

Skiphours feed element

optional

  • access: public
string $syndicationURL = "" (line 37)

Syndication URL feed element

optional

  • access: public
string $ttl = "" (line 135)

TTL feed attribute

optional

  • access: public
string $webmaster = "" (line 115)

Webmaster email feed element

optional

  • access: public

Inherited Variables

Inherited from JDocument

Variable JDocument::$description
Variable JDocument::$direction
Variable JDocument::$language
Variable JDocument::$link
Variable JDocument::$title
Variable JDocument::$_generator
Methods
Constructor __construct (line 181)

Class constructor

  • access: protected
JDocumentFeed __construct ([array $options = array()])
  • array $options: Associative array of options

Redefinition of:
JDocument::__construct()
Class constructor
addItem (line 236)

Adds an JFeedItem to the feed.

  • access: public
void addItem ( &$item, object JFeedItem $item)
render (line 197)

Render the document

  • return: rendered data
  • access: public
The render ([boolean $cache = false], [array $params = array()])
  • boolean $cache: If true, cache the output
  • array $params: Associative array of attributes

Redefinition of:
JDocument::render()
Outputs the document

Inherited Methods

Inherited From JDocument

 JDocument::__construct()
 JDocument::addScript()
 JDocument::addScriptDeclaration()
 JDocument::addStyleDeclaration()
 JDocument::addStyleSheet()
 JDocument::getBuffer()
 JDocument::getCharset()
 JDocument::getDescription()
 JDocument::getDirection()
 JDocument::getGenerator()
 JDocument::getHeadData()
 JDocument::getInstance()
 JDocument::getLanguage()
 JDocument::getLink()
 JDocument::getMetaData()
 JDocument::getModifiedDate()
 JDocument::getTitle()
 JDocument::getType()
 JDocument::loadRenderer()
 JDocument::render()
 JDocument::setBuffer()
 JDocument::setCharset()
 JDocument::setDescription()
 JDocument::setDirection()
 JDocument::setGenerator()
 JDocument::setHeadData()
 JDocument::setLanguage()
 JDocument::setLineEnd()
 JDocument::setLink()
 JDocument::setMetaData()
 JDocument::setMimeEncoding()
 JDocument::setModifiedDate()
 JDocument::setTab()
 JDocument::setTitle()

Inherited From JObject

 JObject::JObject()
 JObject::__construct()
 JObject::get()
 JObject::getPublicProperties()
 JObject::set()
 JObject::toString()

Documentation generated on Mon, 05 Mar 2007 20:58:11 +0000 by phpDocumentor 1.3.1