Feed/Writer/Renderer/Feed/Atom.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

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: Atom.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Feed_Writer_Renderer_Feed_Atom

Package: Zend\Feed\Writer
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

>VPropertyprotectedstring $_type = null
inherited
Holds the value "atom" or "rss" depending on the feed type set when when last exported.
Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::$$_type\Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::$$_type

Methods

methodpublic__construct(\Zend_Feed_Writer_Feed $container) : void

Constructor

Parameters
NameTypeDescription
$container\Zend_Feed_Writer_Feed
methodprotected_setAuthors(\DOMDocument $dom, \DOMElement $root) : void
Parameters
NameTypeDescription
$dom\DOMDocument
$root\DOMElement
methodprotected_setBaseUrl(\DOMDocument $dom, \DOMElement $root) : void
inherited

Set base URL to feed links

Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setBaseUrl()
Parameters
NameTypeDescription
$dom\DOMDocument
$root\DOMElement
methodprotected_setCategories(\DOMDocument $dom, \DOMElement $root) : void
Parameters
NameTypeDescription
$dom\DOMDocument
$root\DOMElement
methodprotected_setCopyright(\DOMDocument $dom, \DOMElement $root) : void
Parameters
NameTypeDescription
$dom\DOMDocument
$root\DOMElement
methodprotected_setDateCreated(\DOMDocument $dom, \DOMElement $root) : void
inherited

Set date feed was created

Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setDateCreated()
Parameters
NameTypeDescription
$dom\DOMDocument
$root\DOMElement
methodprotected_setDateModified(\DOMDocument $dom, \DOMElement $root) : void
inherited

Set date feed was last modified

Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setDateModified()
Parameters
NameTypeDescription
$dom\DOMDocument
$root\DOMElement
methodprotected_setDescription(\DOMDocument $dom, \DOMElement $root) : void
Parameters
NameTypeDescription
$dom\DOMDocument
$root\DOMElement
methodprotected_setFeedLinks(\DOMDocument $dom, \DOMElement $root) : void
Parameters
NameTypeDescription
$dom\DOMDocument
$root\DOMElement
methodprotected_setGenerator(\DOMDocument $dom, \DOMElement $root) : void
inherited

Set feed generator string

Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setGenerator()
Parameters
NameTypeDescription
$dom\DOMDocument
$root\DOMElement
methodprotected_setHubs(\DOMDocument $dom, \DOMElement $root) : void
inherited

Set hubs to which this feed pushes

Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setHubs()
Parameters
NameTypeDescription
$dom\DOMDocument
$root\DOMElement
methodprotected_setIcon(\DOMDocument $dom, \DOMElement $root) : void
inherited

Set feed level icon (image)

Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setIcon()
Parameters
NameTypeDescription
$dom\DOMDocument
$root\DOMElement
methodprotected_setId(\DOMDocument $dom, \DOMElement $root) : void
inherited

Set feed identifier

Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setId()
Parameters
NameTypeDescription
$dom\DOMDocument
$root\DOMElement
methodprotected_setImage(\DOMDocument $dom, \DOMElement $root) : void
inherited

Set feed level logo (image)

Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setImage()
Parameters
NameTypeDescription
$dom\DOMDocument
$root\DOMElement
methodprotected_setLanguage(\DOMDocument $dom, \DOMElement $root) : void
Parameters
NameTypeDescription
$dom\DOMDocument
$root\DOMElement
methodprotected_setLink(\DOMDocument $dom, \DOMElement $root) : void
inherited

Set link to feed

Inherited from: \Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract::_setLink()
Parameters
NameTypeDescription
$dom\DOMDocument
$root\DOMElement
methodprotected_setTitle(\DOMDocument $dom, \DOMElement $root) : void
Parameters
NameTypeDescription
$dom\DOMDocument
$root\DOMElement
methodpublicgetDataContainer() : mixed
inherited

Get data container containing feed items

Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::getDataContainer()
Returns
TypeDescription
mixed
methodpublicgetDomDocument() : \DOMDocument
Returns
TypeDescription
\DOMDocument
methodpublicgetElement() : \DOMElement
inherited

Get document element from DOM

Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::getElement()
Returns
TypeDescription
\DOMElement
methodpublicgetEncoding() : string
Returns
TypeDescription
string
methodpublicgetExceptions() : array
inherited

Get list of thrown exceptions

Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::getExceptions()
Returns
TypeDescription
array
methodpublicgetRootElement() : \DOMElement
inherited

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

Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::getRootElement()
Returns
TypeDescription
\DOMElement
methodpublicgetType() : string
inherited

Retrieve the current or last feed type exported.

Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::getType()
Returns
TypeDescription
stringValue will be "rss" or "atom"
methodpublicignoreExceptions() : mixed
inherited

Should exceptions be ignored?

Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::ignoreExceptions()
Returns
TypeDescription
mixed
methodpublicrender() : \Zend_Feed_Writer_Renderer_Feed_Atom

Render Atom feed

methodpublicsaveXml() : string
inherited

Save feed and/or entry to XML and return string

Inherited from: \Zend_Feed_Writer_Renderer_RendererInterface::saveXml()
Returns
TypeDescription
string
methodpublicsetRootElement(\DOMElement $root) : void
inherited

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

Parameters
NameTypeDescription
$root\DOMElement
methodpublicsetType(string $type) : void
inherited

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.

Parameters
NameTypeDescription
$typestring
Documentation was generated by phpDocumentor 2.0.0a12.