Feed/Writer/Renderer/Feed/Atom/Source.php
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Feed_Writer
- Version
- $Id: Source.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Feed_Writer_Renderer_Feed_Atom_Source
- Implements
- \Zend_Feed_Writer_Renderer_RendererInterface
- Parent(s)
- \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract < \Zend_Feed_Writer_Renderer_RendererAbstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties


mixed $_container = null
null
Details- Type
- mixed
- Inherited_from
- \Zend_Feed_Writer_Renderer_RendererAbstract::$$_container
- Inherited_from
- \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::$$_container


\DOMDocument $_dom = null
null
Details- Type
- \DOMDocument
- Inherited_from
- \Zend_Feed_Writer_Renderer_RendererAbstract::$$_dom
- Inherited_from
- \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::$$_dom


string $_encoding = 'UTF-8'
'UTF-8'
Details- Type
- string
- Inherited_from
- \Zend_Feed_Writer_Renderer_RendererAbstract::$$_encoding
- Inherited_from
- \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::$$_encoding


array $_exceptions = array()
array()
Details- Type
- array
- Inherited_from
- \Zend_Feed_Writer_Renderer_RendererAbstract::$$_exceptions
- Inherited_from
- \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::$$_exceptions


array $_extensions = array()
array()
Details- Type
- array
- Inherited_from
- \Zend_Feed_Writer_Renderer_RendererAbstract::$$_extensions
- Inherited_from
- \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::$$_extensions


bool $_ignoreExceptions = false
false
Details- Type
- bool
- Inherited_from
- \Zend_Feed_Writer_Renderer_RendererAbstract::$$_ignoreExceptions
- Inherited_from
- \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::$$_ignoreExceptions


\DOMElement $_rootElement = null
null
Details

string $_type = null
null
Details- Type
- string
- Inherited_from
- \Zend_Feed_Writer_Renderer_RendererAbstract::$$_type
- Inherited_from
- \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::$$_type
Methods


__construct(\Zend_Feed_Writer_Feed_Source $container) : void
Constructor
Name | Type | Description |
---|---|---|
$container | \Zend_Feed_Writer_Feed_Source |


_loadExtensions() : void
Load extensions from Zend_Feed_Writer
Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::_loadExtensions()\Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_loadExtensions()

_setAuthors(\DOMDocument $dom, \DOMElement $root) : void
Set feed authors
Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setAuthors()Name | Type | Description |
---|---|---|
$dom | \DOMDocument | |
$root | \DOMElement |


_setBaseUrl(\DOMDocument $dom, \DOMElement $root) : void
Set base URL to feed links
Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setBaseUrl()Name | Type | Description |
---|---|---|
$dom | \DOMDocument | |
$root | \DOMElement |


_setCategories(\DOMDocument $dom, \DOMElement $root) : void
Set feed cateories
Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setCategories()Name | Type | Description |
---|---|---|
$dom | \DOMDocument | |
$root | \DOMElement |


_setCopyright(\DOMDocument $dom, \DOMElement $root) : void
Set feed copyright
Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setCopyright()Name | Type | Description |
---|---|---|
$dom | \DOMDocument | |
$root | \DOMElement |


_setDateCreated(\DOMDocument $dom, \DOMElement $root) : void
Set date feed was created
Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setDateCreated()Name | Type | Description |
---|---|---|
$dom | \DOMDocument | |
$root | \DOMElement |


_setDateModified(\DOMDocument $dom, \DOMElement $root) : void
Set date feed was last modified
Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setDateModified()Name | Type | Description |
---|---|---|
$dom | \DOMDocument | |
$root | \DOMElement |


_setDescription(\DOMDocument $dom, \DOMElement $root) : void
Set feed description
Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setDescription()Name | Type | Description |
---|---|---|
$dom | \DOMDocument | |
$root | \DOMElement |


_setFeedLinks(\DOMDocument $dom, \DOMElement $root) : void
Set feed links
Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setFeedLinks()Name | Type | Description |
---|---|---|
$dom | \DOMDocument | |
$root | \DOMElement |


_setGenerator(\DOMDocument $dom, \DOMElement $root) : void
Set feed generator string
Name | Type | Description |
---|---|---|
$dom | \DOMDocument | |
$root | \DOMElement |


_setHubs(\DOMDocument $dom, \DOMElement $root) : void
Set hubs to which this feed pushes
Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setHubs()Name | Type | Description |
---|---|---|
$dom | \DOMDocument | |
$root | \DOMElement |


_setIcon(\DOMDocument $dom, \DOMElement $root) : void
Set feed level icon (image)
Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setIcon()Name | Type | Description |
---|---|---|
$dom | \DOMDocument | |
$root | \DOMElement |


_setId(\DOMDocument $dom, \DOMElement $root) : void
Set feed identifier
Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setId()Name | Type | Description |
---|---|---|
$dom | \DOMDocument | |
$root | \DOMElement |


_setImage(\DOMDocument $dom, \DOMElement $root) : void
Set feed level logo (image)
Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setImage()Name | Type | Description |
---|---|---|
$dom | \DOMDocument | |
$root | \DOMElement |


_setLanguage(\DOMDocument $dom, \DOMElement $root) : void
Set feed language
Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setLanguage()Name | Type | Description |
---|---|---|
$dom | \DOMDocument | |
$root | \DOMElement |


_setLink(\DOMDocument $dom, \DOMElement $root) : void
Set link to feed
Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setLink()Name | Type | Description |
---|---|---|
$dom | \DOMDocument | |
$root | \DOMElement |


_setTitle(\DOMDocument $dom, \DOMElement $root) : void
Set feed title
Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setTitle()Name | Type | Description |
---|---|---|
$dom | \DOMDocument | |
$root | \DOMElement |


getDataContainer() : mixed
Get data container containing feed items
Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::getDataContainer()Type | Description |
---|---|
mixed |


getDomDocument() : \DOMDocument
Get DOM document
Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::getDomDocument()Type | Description |
---|---|
\DOMDocument |


getElement() : \DOMElement
Get document element from DOM
Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::getElement()Type | Description |
---|---|
\DOMElement |


getEncoding() : string
Get feed encoding
Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::getEncoding()\Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::getEncoding()Type | Description |
---|---|
string |


getExceptions() : array
Get list of thrown exceptions
Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::getExceptions()Type | Description |
---|---|
array |


getRootElement() : \DOMElement
Retrieve the absolute root element for the XML feed being generated.
Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::getRootElement()Type | Description |
---|---|
\DOMElement |


getType() : string
Retrieve the current or last feed type exported.
Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::getType()Type | Description |
---|---|
string | Value will be "rss" or "atom" |


ignoreExceptions() : mixed
Should exceptions be ignored?
Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::ignoreExceptions()Type | Description |
---|---|
mixed |


render() : \Zend_Feed_Writer_Renderer_Feed_Atom
Render Atom Feed Metadata (Source element)
Type | Description |
---|---|
\Zend_Feed_Writer_Renderer_Feed_Atom |


saveXml() : string
Save feed and/or entry to XML and return string
Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::saveXml()Type | Description |
---|---|
string |


setEncoding(string $enc) : \Zend_Feed_Writer_Renderer_RendererAbstract
Set feed encoding
Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::setEncoding()\Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::setEncoding()Name | Type | Description |
---|---|---|
$enc | string |
Type | Description |
---|---|
\Zend_Feed_Writer_Renderer_RendererAbstract |


setRootElement(\DOMElement $root) : void
Sets the absolute root element for the XML feed being generated.
Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::setRootElement()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 ;).
Name | Type | Description |
---|---|---|
$root | \DOMElement |


setType(string $type) : void
Set the current feed type being exported to "rss" or "atom".
Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::setType()This allows other objects to gracefully choose whether to execute or not, depending on their appropriateness for the current type, e.g. renderers.
Name | Type | Description |
---|---|---|
$type | string |