Class JDocumentFeed

Description

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

  • since: 11.1

Located in /libraries/joomla/document/feed/feed.php (line 19)

JDocument
   |
   --JDocumentFeed
Variable Summary
 string $category
 string $copyright
 string $docs
 string $editor
 string $editorEmail
 object $image
 array $items
 string $pubDate
 string $rating
 string $skipDays
 string $skipHours
 string $ttl
 string $webmaster
Method Summary
 JDocumentFeed __construct ([array $options = array()])
 The render ([boolean $cache = false], [array $params = array()])
Variables
string $category = "" (line 117)

Category feed element

optional

  • since: 11.1
  • access: public
string $copyright = "" (line 49)

Copyright feed element

optional

  • since: 11.1
  • access: public
string $docs = "" (line 87)

Docs feed element

  • since: 11.1
  • access: public
string $editor = "" (line 79)

Editor feed element

optional

  • since: 11.1
  • access: public
string $editorEmail = "" (line 97)

Editor email feed element

optional

  • since: 11.1
  • access: public
object $image = null (line 39)

Image feed element

optional

  • since: 11.1
  • access: public
array $items = array() (line 165)

The feed items collection

  • since: 11.1
  • access: public
string $lastBuildDate = "" (line 69)

Lastbuild date feed element

optional

  • since: 11.1
  • access: public
string $pubDate = "" (line 59)

Published date feed element

optional

  • since: 11.1
  • access: public
string $rating = "" (line 137)

Rating feed element

optional

  • since: 11.1
  • access: public
string $skipDays = "" (line 157)

Skipdays feed element

optional

  • since: 11.1
  • access: public
string $skipHours = "" (line 147)

Skiphours feed element

optional

  • since: 11.1
  • access: public
string $syndicationURL = "" (line 29)

Syndication URL feed element

optional

  • since: 11.1
  • access: public
string $ttl = "" (line 127)

TTL feed attribute

optional

  • since: 11.1
  • access: public
string $webmaster = "" (line 107)

Webmaster email feed element

optional

  • since: 11.1
  • access: public

Inherited Variables

Inherited from JDocument

JDocument::$base
JDocument::$description
JDocument::$direction
JDocument::$instances
JDocument::$language
JDocument::$link
JDocument::$mediaVersion
JDocument::$title
JDocument::$_buffer
JDocument::$_charset
JDocument::$_engine
JDocument::$_generator
JDocument::$_lineEnd
JDocument::$_mdate
JDocument::$_metaTags
JDocument::$_mime
JDocument::$_namespace
JDocument::$_profile
JDocument::$_script
JDocument::$_scripts
JDocument::$_style
JDocument::$_styleSheets
JDocument::$_tab
JDocument::$_type
Methods
Constructor __construct (line 174)

Class constructor

  • since: 11.1
  • access: public
JDocumentFeed __construct ([array $options = array()])
  • array $options: Associative array of options

Redefinition of:
JDocument::__construct()
Class constructor.
addItem (line 234)

Adds an JFeedItem to the feed.

  • return: instance of $this to allow chaining
  • since: 11.1
  • access: public
JDocumentFeed addItem (JFeedItem $item)
  • JFeedItem $item: The feeditem to add to the feed.
render (line 194)

Render the document

  • return: rendered data
  • todo: Make this cacheable
  • throws: Exception
  • since: 11.1
  • 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::addScriptVersion()
 JDocument::addStyleDeclaration()
 JDocument::addStyleSheet()
 JDocument::addStyleSheetVersion()
 JDocument::getBase()
 JDocument::getBuffer()
 JDocument::getCharset()
 JDocument::getDescription()
 JDocument::getDirection()
 JDocument::getGenerator()
 JDocument::getInstance()
 JDocument::getLanguage()
 JDocument::getLink()
 JDocument::getMediaVersion()
 JDocument::getMetaData()
 JDocument::getMimeEncoding()
 JDocument::getModifiedDate()
 JDocument::getTitle()
 JDocument::getType()
 JDocument::loadRenderer()
 JDocument::parse()
 JDocument::render()
 JDocument::setBase()
 JDocument::setBuffer()
 JDocument::setCharset()
 JDocument::setDescription()
 JDocument::setDirection()
 JDocument::setGenerator()
 JDocument::setLanguage()
 JDocument::setLineEnd()
 JDocument::setLink()
 JDocument::setMediaVersion()
 JDocument::setMetaData()
 JDocument::setMimeEncoding()
 JDocument::setModifiedDate()
 JDocument::setTab()
 JDocument::setTitle()
 JDocument::setType()
 JDocument::_getLineEnd()
 JDocument::_getTab()

Documentation generated on Tue, 19 Nov 2013 15:02:55 +0100 by phpDocumentor 1.4.3