\JDocumentFeed

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

Synopsis

class JDocumentFeed extends JDocument {

// members
public $syndicationURL;
public $image;
public $copyright;
public $pubDate;
public $lastBuildDate;
public $editor;
public $docs;
public $editorEmail;
public $webmaster;
public $category;
public $ttl;
public $rating;
public $skipHours;
public $skipDays;
public $items;

// Inherited members from JDocument
public $title;
public $description;
public $link;
public $base;
public $language;
public $direction;
public $_generator;
public $_mdate;
public $_tab;
public $_lineEnd;
public $_charset;
public $_mime;
public $_namespace;
public $_profile;
public $_scripts;
public $_script;
public $_styleSheets;
public $_style;
public $_metaTags;
public $_engine;
public $_type;
public $_buffer;
protected $instances;
protected $mediaVersion;

// methods
public void __construct()
public The render()
public JDocumentFeed addItem()

// Inherited methods from JDocument
public void __construct()
public static getInstance()
public JDocument setType()
public string getType()
public The getBuffer()
public JDocument setBuffer()
public string getMetaData()
public JDocument setMetaData()
public JDocument addScript()
public JDocument addScriptVersion()
public JDocument addScriptDeclaration()
public JDocument addStyleSheet()
public JDocument addStyleSheetVersion()
public JDocument addStyleDeclaration()
public JDocument setCharset()
public string getCharset()
public JDocument setLanguage()
public string getLanguage()
public JDocument setDirection()
public string getDirection()
public JDocument setTitle()
public string getTitle()
public JDocument setMediaVersion()
public string getMediaVersion()
public JDocument setBase()
public string getBase()
public JDocument setDescription()
public string getDescription()
public JDocument setLink()
public string getLink()
public JDocument setGenerator()
public string getGenerator()
public JDocument setModifiedDate()
public string getModifiedDate()
public JDocument setMimeEncoding()
public string getMimeEncoding()
public JDocument setLineEnd()
public string _getLineEnd()
public JDocument setTab()
public string _getTab()
public JDocumentRenderer loadRenderer()
public JDocument parse()
public The render()

}

Hierarchy

Extends

JDocument

Tasks

Tasks

Line	Task
194+	Make this cacheable

Members

protected

$instances — array
JDocument instances container.
$mediaVersion — string
Media version added to assets

public

$_generator — string
Document generator

$_lineEnd — string
Contains the line end string

$_mdate — string
Document modified date

$_metaTags — array
Array of meta tags

$_mime — string
Document mime type

$_namespace — string
Document namespace

$_profile — string
Document profile

$_script — array
Array of scripts placed in the header

$_scripts — array
Array of linked scripts

$_style — array
Array of included style declarations

$_styleSheets — array
Array of linked style sheets

$_tab — string
Tab string

$_type — string
The document type

$base — string
Document base URL

$category — string
Category feed element

$copyright — string
Copyright feed element

$description — string
Document description

$direction — string
Contains the document direction setting

$docs — string
Docs feed element

$editor — string
Editor feed element

$editorEmail — string
Editor email feed element

$image —
Image feed element

$items — array
The feed items collection

$language — string
Contains the document language setting

$lastBuildDate — string
Lastbuild date feed element

$link — string
Document full URL

$pubDate — string
Published date feed element

$rating — string
Rating feed element

$skipDays — string
Skipdays feed element

$skipHours — string
Skiphours feed element

$syndicationURL — string
Syndication URL feed element

$title — string
Document title

$ttl — string
TTL feed attribute

$webmaster — string
Webmaster email feed element

Methods

public

__construct() — Class constructor
addItem() — Adds an JFeedItem to the feed.
render() — Render the document

Inherited from JDocument

public

_getLineEnd() — Returns the lineEnd
_getTab() — Returns a string containing the unit for indenting HTML
addScript() — Adds a linked script to the page
addScriptDeclaration() — Adds a script to the page
addScriptVersion() — Adds a linked script to the page with a version to allow to flush it. Ex: myscript.js54771616b5bceae9df03c6173babf11d If not specified Joomla! automatically handles versioning
addStyleDeclaration() — Adds a stylesheet declaration to the page
addStyleSheet() — Adds a linked stylesheet to the page
addStyleSheetVersion() — Adds a linked stylesheet version to the page. Ex: template.css?54771616b5bceae9df03c6173babf11d If not specified Joomla! automatically handles versioning
getBase() — Return the base URI of the document.
getBuffer() — Get the contents of the document buffer
getCharset() — Returns the document charset encoding.
getDescription() — Return the title of the page.
getDirection() — Returns the document direction declaration.
getGenerator() — Returns the document generator
getInstance() — Returns the global JDocument object, only creating it if it doesn't already exist.
getLanguage() — Returns the document language.
getLink() — Returns the document base url
getMediaVersion() — Return the media version
getMetaData() — Gets a meta tag.
getMimeEncoding() — Return the document MIME encoding that is sent to the browser.
getModifiedDate() — Returns the document modified date
getTitle() — Return the title of the document.
getType() — Returns the document type
loadRenderer() — Load a renderer
parse() — Parses the document and prepares the buffers
render() — Outputs the document
setBase() — Sets the base URI of the document
setBuffer() — Set the contents of the document buffer
setCharset() — Sets the document charset
setDescription() — Sets the description of the document
setDirection() — Sets the global document direction declaration. Default is left-to-right (ltr).
setGenerator() — Sets the document generator
setLanguage() — Sets the global document language declaration. Default is English (en-gb).
setLineEnd() — Sets the line end style to Windows, Mac, Unix or a custom string.
setLink() — Sets the document link
setMediaVersion() — Set the assets version
setMetaData() — Sets or alters a meta tag.
setMimeEncoding() — Sets the document MIME encoding that is sent to the browser.
setModifiedDate() — Sets the document modified date
setTab() — Sets the string used to indent HTML
setTitle() — Sets the title of the document
setType() — Set the document type