Zend Framework  3.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AbstractRenderer Class Reference

Public Member Functions

 __construct ($container)
 Constructor.
 
 saveXml ()
 Save XML to string.
 
 getDomDocument ()
 Get DOM document.
 
 getElement ()
 Get document element from DOM.
 
 getDataContainer ()
 Get data container of items being rendered.
 
 setEncoding ($enc)
 Set feed encoding.
 
 getEncoding ()
 Get feed encoding.
 
 ignoreExceptions ($bool=true)
 Indicate whether or not to ignore exceptions.
 
 getExceptions ()
 Get exception list.
 
 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.
 

Protected Member Functions

 _loadExtensions ()
 Load extensions from Zend.
 

Protected Attributes

 $extensions = []
 
 $container = null
 
 $dom = null
 
 $ignoreExceptions = false
 
 $exceptions = []
 
 $encoding = 'UTF-8'
 
 $type = null
 
 $rootElement = null
 

Constructor & Destructor Documentation

__construct (   $container)

Constructor.

Parameters
Writer\AbstractFeed$container

Member Function Documentation

_loadExtensions ( )
protected

Load extensions from Zend.

Returns
void
getDataContainer ( )

Get data container of items being rendered.

Returns
Writer
getDomDocument ( )

Get DOM document.

Returns
DOMDocument
getElement ( )

Get document element from DOM.

Returns
DOMElement
getEncoding ( )

Get feed encoding.

Returns
string
getExceptions ( )

Get exception list.

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 (   $bool = true)

Indicate whether or not to ignore exceptions.

Parameters
bool$bool
Returns
AbstractRenderer
Exceptions
Writer\Exception\InvalidArgumentException
saveXml ( )

Save XML to string.

Returns
string
setEncoding (   $enc)

Set feed encoding.

Parameters
string$enc
Returns
AbstractRenderer
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

Member Data Documentation

$container = null
protected
$dom = null
protected
$encoding = 'UTF-8'
protected
$exceptions = []
protected
$extensions = []
protected
$ignoreExceptions = false
protected
$rootElement = null
protected
$type = null
protected