Support Joomla!

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

 Class JDocumentFeed

Description

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

  • since: 1.5

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

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

Category feed element

optional

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

Copyright feed elememnt

optional

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

Docs feed element

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

Editor feed element

optional

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

Editor email feed element

optional

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

Image feed element

optional

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

The feed items collection

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

Lastbuild date feed element

optional

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

Published date feed element

optional

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

Rating feed element

optional

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

Skipdays feed element

optional

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

Skiphours feed element

optional

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

Syndication URL feed element

optional

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

TTL feed attribute

optional

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

Webmaster email feed element

optional

  • access: public

Inherited Variables

Inherited from JDocument

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

Inherited from JObject

Variable JObject::$_errors
Methods
Constructor __construct (line 180)

Class constructor

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

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

Adds an JFeedItem to the feed.

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

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

Documentation generated on Sat, 14 Nov 2009 11:12:44 +0000 by phpDocumentor 1.3.1