Zend Framework  1.12
Public Member Functions | Protected Member Functions | List of all members
Zend_Feed_Writer_Renderer_Entry_Atom Class Reference

Public Member Functions

 __construct (Zend_Feed_Writer_Entry $container)
 Constructor.
 
 render ()
 Render atom entry.
 
- Public Member Functions inherited from Zend_Feed_Writer_Renderer_RendererAbstract
 __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.
 
- Public Member Functions inherited from Zend_Feed_Writer_Renderer_RendererInterface
 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.
 

Protected Member Functions

 _setTitle (DOMDocument $dom, DOMElement $root)
 Set entry title.
 
 _setDescription (DOMDocument $dom, DOMElement $root)
 Set entry description.
 
 _setDateModified (DOMDocument $dom, DOMElement $root)
 Set date entry was modified.
 
 _setDateCreated (DOMDocument $dom, DOMElement $root)
 Set date entry was created.
 
 _setAuthors (DOMDocument $dom, DOMElement $root)
 Set entry authors.
 
 _setEnclosure (DOMDocument $dom, DOMElement $root)
 Set entry enclosure.
 
 _setLink (DOMDocument $dom, DOMElement $root)
 
 _setId (DOMDocument $dom, DOMElement $root)
 Set entry identifier.
 
 _validateTagUri ($id)
 Validate a URI using the tag scheme (RFC 4151)
 
 _setContent (DOMDocument $dom, DOMElement $root)
 Set entry content.
 
 _loadXhtml ($content)
 Load a HTML string and attempt to normalise to XML.
 
 _setCategories (DOMDocument $dom, DOMElement $root)
 Set entry cateories.
 
 _setSource (DOMDocument $dom, DOMElement $root)
 Append Source element (Atom 1.0 Feed Metadata)
 
- Protected Member Functions inherited from Zend_Feed_Writer_Renderer_RendererAbstract
 _loadExtensions ()
 Load extensions from Zend_Feed_Writer.
 

Additional Inherited Members

- Protected Attributes inherited from Zend_Feed_Writer_Renderer_RendererAbstract
 $_extensions = array()
 
 $_container = null
 
 $_dom = null
 
 $_ignoreExceptions = false
 
 $_exceptions = array()
 
 $_encoding = 'UTF-8'
 
 $_type = null
 
 $_rootElement = null
 

Constructor & Destructor Documentation

__construct ( Zend_Feed_Writer_Entry  $container)

Constructor.

Parameters
Zend_Feed_Writer_Entry$container
Returns
void

Member Function Documentation

_loadXhtml (   $content)
protected

Load a HTML string and attempt to normalise to XML.

_setAuthors ( DOMDocument  $dom,
DOMElement  $root 
)
protected

Set entry authors.

Parameters
DOMDocument$dom
DOMElement$root
Returns
void

This will actually trigger an Exception at the feed level if a feed level author is not set.

_setCategories ( DOMDocument  $dom,
DOMElement  $root 
)
protected

Set entry cateories.

Parameters
DOMDocument$dom
DOMElement$root
Returns
void
_setContent ( DOMDocument  $dom,
DOMElement  $root 
)
protected

Set entry content.

Parameters
DOMDocument$dom
DOMElement$root
Returns
void
_setDateCreated ( DOMDocument  $dom,
DOMElement  $root 
)
protected

Set date entry was created.

Parameters
DOMDocument$dom
DOMElement$root
Returns
void
_setDateModified ( DOMDocument  $dom,
DOMElement  $root 
)
protected

Set date entry was modified.

Parameters
DOMDocument$dom
DOMElement$root
Returns
void
_setDescription ( DOMDocument  $dom,
DOMElement  $root 
)
protected

Set entry description.

Parameters
DOMDocument$dom
DOMElement$root
Returns
void
_setEnclosure ( DOMDocument  $dom,
DOMElement  $root 
)
protected

Set entry enclosure.

Parameters
DOMDocument$dom
DOMElement$root
Returns
void
_setId ( DOMDocument  $dom,
DOMElement  $root 
)
protected

Set entry identifier.

Parameters
DOMDocument$dom
DOMElement$root
Returns
void
_setLink ( DOMDocument  $dom,
DOMElement  $root 
)
protected
_setSource ( DOMDocument  $dom,
DOMElement  $root 
)
protected

Append Source element (Atom 1.0 Feed Metadata)

Parameters
DOMDocument$dom
DOMElement$root
Returns
void
_setTitle ( DOMDocument  $dom,
DOMElement  $root 
)
protected

Set entry title.

Parameters
DOMDocument$dom
DOMElement$root
Returns
void
_validateTagUri (   $id)
protected

Validate a URI using the tag scheme (RFC 4151)

Parameters
string$id
Returns
bool
render ( )