RendererInterface Interface Reference

Public Member Functions
	render ()
	Render feed/entry.
	saveXml ()
	Save feed and/or entry to XML and return string.
	getDomDocument ()
	Get DOM document.
	getElement ()
	Get document element from DOM.
	getDataContainer ()
	Get data container containing feed items.
	ignoreExceptions ()
	Should exceptions be ignored?
	getExceptions ()
	Get list of thrown exceptions.
	setType ($type)
	Set the current feed type being exported to "rss" or "atom".
	getType ()
	Retrieve the current or last feed type exported.
	setRootElement (DOMElement $root)
	Sets the absolute root element for the XML feed being generated.
	getRootElement ()
	Retrieve the absolute root element for the XML feed being generated.

Member Function Documentation

getDataContainer

(

)

Get data container containing feed items.

Returns

mixed

getDomDocument

(

)

Get DOM document.

Returns

DOMDocument

getElement

(

)

Get document element from DOM.

Returns

DOMElement

getExceptions

(

)

Get list of thrown exceptions.

Returns

array

getRootElement

(

)

Retrieve the absolute root element for the XML feed being generated.

Returns

DOMElement

getType

(

)

Retrieve the current or last feed type exported.

Returns

string Value will be "rss" or "atom"

ignoreExceptions

(

)

Should exceptions be ignored?

Returns

mixed

render

(

)

Render feed/entry.

Returns

void

Implemented in Rss, Rss, Atom, AtomDeleted, AtomSource, Deleted, Atom, and Source.

saveXml

(

)

Save feed and/or entry to XML and return string.

Returns

string

setRootElement

(

DOMElement

$root

)

Sets the absolute root element for the XML feed being generated.

This helps simplify the appending of namespace declarations, but also ensures namespaces are added to the root element - not scattered across the entire XML file - may assist namespace unsafe parsers and looks pretty ;).

Parameters

DOMElement

$root

setType

(

$type

)

Set the current feed type being exported to "rss" or "atom".

This allows other objects to gracefully choose whether to execute or not, depending on their appropriateness for the current type, e.g. renderers.

Parameters

string

$type