Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class FeedDocument - list of methods

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

Extends

Document
Package: Joomla\CMS\Document
Copyright: (C) 2006 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Document/FeedDocument.php
Project: Joomla

Method Summary

public
__construct
(mixed $options = array())

Class constructor
Parameters
  • array $options Associative array of options
Since
  • 1.7.0
Show source code of this method: __construct Source Code

public string
(mixed $cache = false, mixed $params = array())

Render the document
Parameters
  • bool $cache If true, cache the output
  • array $params Associative array of attributes
Returns
  • string The rendered data
Since
  • 1.7.0
-
  • \Exception
  • Make this cacheable
Show source code of this method: render Source Code

public \Joomla\CMS\Document\FeedDocument
(\Joomla\CMS\Document\Feed\FeedItem $item)

Adds a FeedItem to the feed.
Parameters
  • \Joomla\CMS\Document\Feed\FeedItem $item The feeditem to add to the feed.
Returns
  • \Joomla\CMS\Document\FeedDocument instance of $this to allow chaining
Since
  • 1.7.0
Show source code of this method: addItem Source Code

Properties Summary

public string
$syndicationURL
Syndication URL feed element
Since
  • 1.7.0
public \Joomla\CMS\Document\Feed\FeedImage
$image
Image feed element
Since
  • 1.7.0
public string
$copyright
Copyright feed element
Since
  • 1.7.0
public string
$pubDate
Published date feed element
Since
  • 1.7.0
public \Joomla\CMS\Date\Date
$lastBuildDate
Lastbuild date feed element
Since
  • 1.7.0
public string
$editor
Editor feed element
Since
  • 1.7.0
public string
$docs
Docs feed element
Since
  • 1.7.0
public string
$editorEmail
Editor email feed element
Since
  • 1.7.0
public string
$webmaster
Webmaster email feed element
Since
  • 1.7.0
public string
$category
Category feed element
Since
  • 1.7.0
public string
$ttl
TTL feed attribute
Since
  • 1.7.0
public string
$rating
Rating feed element
Since
  • 1.7.0
public string
$skipHours
Skiphours feed element
Since
  • 1.7.0
public string
$skipDays
Skipdays feed element
Since
  • 1.7.0
public \Joomla\CMS\Document\Feed\FeedItem[]
$items
The feed items collection
Since
  • 1.7.0

Tags Summary

Since
1.7.0