Zend Framework » \Zend\Feed\Writer\Renderer\Feed\AtomSource

Methods

Constructor

__construct(\Zend\Feed\Writer\Source $container)

Parameters

$container

\Zend\Feed\Writer\Source

Get data container containing feed items

getDataContainer() : mixed

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\RendererInterface::getDataContainer()

Returns

mixed

Get DOM document

getDomDocument() : \DOMDocument

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\RendererInterface::getDomDocument()

Returns

\DOMDocument

Get document element from DOM

getElement() : \DOMElement

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\RendererInterface::getElement()

Returns

\DOMElement

Get feed encoding

getEncoding() : string

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\AbstractRenderer::getEncoding()
inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::getEncoding()

Returns

string

Get list of thrown exceptions

getExceptions() : array

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\RendererInterface::getExceptions()

Returns

array

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

getRootElement() : \DOMElement

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\RendererInterface::getRootElement()

Returns

\DOMElement

Retrieve the current or last feed type exported.

getType() : string

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\RendererInterface::getType()

Returns

stringValue will be "rss" or "atom"

Should exceptions be ignored?

ignoreExceptions() : mixed

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\RendererInterface::ignoreExceptions()

Exceptions

`\Zend\Feed\Writer\Exception\InvalidArgumentException`

Returns

mixed

Render Atom Feed Metadata (Source element)

render() : \Zend\Feed\Writer\Renderer\Feed\Atom

Returns

\Zend\Feed\Writer\Renderer\Feed\Atom

Save feed and/or entry to XML and return string

saveXml() : string

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\RendererInterface::saveXml()

Returns

string

Set feed encoding

setEncoding(string $enc) : \Zend\Feed\Writer\Renderer\AbstractRenderer

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\AbstractRenderer::setEncoding()
inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::setEncoding()

Parameters

$enc

string

Returns

\Zend\Feed\Writer\Renderer\AbstractRenderer

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

setRootElement(\DOMElement $root)

Inherited

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 ;).

inherited_from	\Zend\Feed\Writer\Renderer\RendererInterface::setRootElement()

Parameters

$root

\DOMElement

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

setType(string $type)

Inherited

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

inherited_from	\Zend\Feed\Writer\Renderer\RendererInterface::setType()

Parameters

$type

string

Load extensions from Zend\Feed\Writer\Writer

_loadExtensions() : void

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\AbstractRenderer::_loadExtensions()
inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::_loadExtensions()

Set feed authors

_setAuthors(\DOMDocument $dom, \DOMElement $root) : void

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::_setAuthors()

Parameters

$dom

\DOMDocument

$root

\DOMElement

Set base URL to feed links

_setBaseUrl(\DOMDocument $dom, \DOMElement $root) : void

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::_setBaseUrl()

Parameters

$dom

\DOMDocument

$root

\DOMElement

Set feed categories

_setCategories(\DOMDocument $dom, \DOMElement $root) : void

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::_setCategories()

Parameters

$dom

\DOMDocument

$root

\DOMElement

Set feed copyright

_setCopyright(\DOMDocument $dom, \DOMElement $root) : void

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::_setCopyright()

Parameters

$dom

\DOMDocument

$root

\DOMElement

Set date feed was created

_setDateCreated(\DOMDocument $dom, \DOMElement $root) : void

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::_setDateCreated()

Parameters

$dom

\DOMDocument

$root

\DOMElement

Set date feed was last modified

_setDateModified(\DOMDocument $dom, \DOMElement $root) : void

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::_setDateModified()

Parameters

$dom

\DOMDocument

$root

\DOMElement

Exceptions

`\Zend\Feed\Writer\Exception\InvalidArgumentException`

Set feed description

_setDescription(\DOMDocument $dom, \DOMElement $root) : void

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::_setDescription()

Parameters

$dom

\DOMDocument

$root

\DOMElement

Set feed links

_setFeedLinks(\DOMDocument $dom, \DOMElement $root) : void

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::_setFeedLinks()

Parameters

$dom

\DOMDocument

$root

\DOMElement

Exceptions

`\Zend\Feed\Writer\Exception\InvalidArgumentException`

Set feed generator string

_setGenerator(\DOMDocument $dom, \DOMElement $root) : void

Parameters

$dom

\DOMDocument

$root

\DOMElement

Set hubs to which this feed pushes

_setHubs(\DOMDocument $dom, \DOMElement $root) : void

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::_setHubs()

Parameters

$dom

\DOMDocument

$root

\DOMElement

Set feed identifier

_setId(\DOMDocument $dom, \DOMElement $root) : void

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::_setId()

Parameters

$dom

\DOMDocument

$root

\DOMElement

Exceptions

`\Zend\Feed\Writer\Exception\InvalidArgumentException`

Set feed level logo (image)

_setImage(\DOMDocument $dom, \DOMElement $root) : void

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::_setImage()

Parameters

$dom

\DOMDocument

$root

\DOMElement

Set feed language

_setLanguage(\DOMDocument $dom, \DOMElement $root) : void

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::_setLanguage()

Parameters

$dom

\DOMDocument

$root

\DOMElement

Set link to feed

_setLink(\DOMDocument $dom, \DOMElement $root) : void

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::_setLink()

Parameters

$dom

\DOMDocument

$root

\DOMElement

Set feed title

_setTitle(\DOMDocument $dom, \DOMElement $root) : void

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::_setTitle()

Parameters

$dom

\DOMDocument

$root

\DOMElement

Exceptions

`\Zend\Feed\Writer\Exception\InvalidArgumentException`

Properties

$container

$container : \Zend\Feed\Writer\AbstractFeed

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\AbstractRenderer::$$container
inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::$$container

$dom

$dom : \DOMDocument

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\AbstractRenderer::$$dom
inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::$$dom

Encoding of all text values

$encoding : string

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\AbstractRenderer::$$encoding
inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::$$encoding

$exceptions

$exceptions : array

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\AbstractRenderer::$$exceptions
inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::$$exceptions

Extensions

$extensions : array

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\AbstractRenderer::$$extensions
inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::$$extensions

$ignoreExceptions

$ignoreExceptions : bool

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\AbstractRenderer::$$ignoreExceptions
inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::$$ignoreExceptions

$rootElement

$rootElement : \DOMElement

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\AbstractRenderer::$$rootElement
inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::$$rootElement

Holds the value "atom" or "rss" depending on the feed type set when when last exported.

$type : string

Inherited

inherited_from	\Zend\Feed\Writer\Renderer\AbstractRenderer::$$type
inherited_from	\Zend\Feed\Writer\Renderer\Feed\AbstractAtom::$$type