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

• since: 1.5
• author: Johan Janssens <johan.janssens@joomla.org>

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

 JObject   (Subpackage Base)

 JDocument
   
    JDocumentFeed   (Subpackage Document)

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

JDocument::$base
JDocument::$description
JDocument::$direction
JDocument::$language
JDocument::$link
JDocument::$title
JDocument::$_generator

Inherited from JObject

JObject::$_errors

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 246)

Adds an JFeedItem to the feed.

• access: public

void addItem ( &$item, object JFeedItem $item)

• object JFeedItem $item: The feeditem to add to the feed.
• &$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::getBase()
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::setBase()
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()
JDocument::setType()

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::getPublicProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()