API Documentation

Feed/Writer/Renderer/Feed/Atom/AtomAbstract.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Feed_Writer  
version
$Id: AtomAbstract.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Feed_Writer_Renderer_Feed_Atom_AtomAbstract

Extends from
\Zend_Feed_Writer_Renderer_RendererAbstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Feed_Writer  

Methods

methodpublic__construct( \Zend_Feed_Writer_Feed $container ) : void

Constructor

Parameters
Name Type Description
$container \Zend_Feed_Writer_Feed
methodprotected_loadExtensions( ) : void

Load extensions from Zend_Feed_Writer

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::_loadExtensions()
methodprotected_setAuthors( \DOMDocument $dom, \DOMElement $root ) : void

Set feed authors

Parameters
Name Type Description
$dom \DOMDocument
$root \DOMElement
methodprotected_setBaseUrl( \DOMDocument $dom, \DOMElement $root ) : void

Set base URL to feed links

Parameters
Name Type Description
$dom \DOMDocument
$root \DOMElement
methodprotected_setCategories( \DOMDocument $dom, \DOMElement $root ) : void

Set feed cateories

Parameters
Name Type Description
$dom \DOMDocument
$root \DOMElement
methodprotected_setCopyright( \DOMDocument $dom, \DOMElement $root ) : void

Set feed copyright

Parameters
Name Type Description
$dom \DOMDocument
$root \DOMElement
methodprotected_setDateCreated( \DOMDocument $dom, \DOMElement $root ) : void

Set date feed was created

Parameters
Name Type Description
$dom \DOMDocument
$root \DOMElement
methodprotected_setDateModified( \DOMDocument $dom, \DOMElement $root ) : void

Set date feed was last modified

Parameters
Name Type Description
$dom \DOMDocument
$root \DOMElement
methodprotected_setDescription( \DOMDocument $dom, \DOMElement $root ) : void

Set feed description

Parameters
Name Type Description
$dom \DOMDocument
$root \DOMElement
methodprotected_setFeedLinks( \DOMDocument $dom, \DOMElement $root ) : void

Set feed links

Parameters
Name Type Description
$dom \DOMDocument
$root \DOMElement
methodprotected_setGenerator( \DOMDocument $dom, \DOMElement $root ) : void

Set feed generator string

Parameters
Name Type Description
$dom \DOMDocument
$root \DOMElement
methodprotected_setHubs( \DOMDocument $dom, \DOMElement $root ) : void

Set hubs to which this feed pushes

Parameters
Name Type Description
$dom \DOMDocument
$root \DOMElement
methodprotected_setIcon( \DOMDocument $dom, \DOMElement $root ) : void

Set feed level icon (image)

Parameters
Name Type Description
$dom \DOMDocument
$root \DOMElement
methodprotected_setId( \DOMDocument $dom, \DOMElement $root ) : void

Set feed identifier

Parameters
Name Type Description
$dom \DOMDocument
$root \DOMElement
methodprotected_setImage( \DOMDocument $dom, \DOMElement $root ) : void

Set feed level logo (image)

Parameters
Name Type Description
$dom \DOMDocument
$root \DOMElement
methodprotected_setLanguage( \DOMDocument $dom, \DOMElement $root ) : void

Set feed language

Parameters
Name Type Description
$dom \DOMDocument
$root \DOMElement
methodprotected_setLink( \DOMDocument $dom, \DOMElement $root ) : void

Set link to feed

Parameters
Name Type Description
$dom \DOMDocument
$root \DOMElement
methodprotected_setTitle( \DOMDocument $dom, \DOMElement $root ) : void

Set feed title

Parameters
Name Type Description
$dom \DOMDocument
$root \DOMElement
methodpublicgetDataContainer( ) : mixed

Get data container of items being rendered

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::getDataContainer()
Returns
Type Description
mixed
methodpublicgetDomDocument( ) : \DOMDocument
Returns
Type Description
\DOMDocument
methodpublicgetElement( ) : \DOMElement

Get document element from DOM

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::getElement()
Returns
Type Description
\DOMElement
methodpublicgetEncoding( ) : string
Returns
Type Description
string
methodpublicgetExceptions( ) : array
Returns
Type Description
array
methodpublicgetRootElement( ) : \DOMElement

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

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::getRootElement()
Returns
Type Description
\DOMElement
methodpublicgetType( ) : string

Retrieve the current or last feed type exported.

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::getType()
Returns
Type Description
string Value will be "rss" or "atom"
methodpublicignoreExceptions( bool $bool = true ) : \Zend_Feed_Writer_Renderer_RendererAbstract

Indicate whether or not to ignore exceptions

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::ignoreExceptions()
Parameters
Name Type Description
$bool bool
Returns
Type Description
\Zend_Feed_Writer_Renderer_RendererAbstract
methodpublicsaveXml( ) : string

Save XML to string

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::saveXml()
Returns
Type Description
string
methodpublicsetEncoding( string $enc ) : \Zend_Feed_Writer_Renderer_RendererAbstract
Parameters
Name Type Description
$enc string
Returns
Type Description
\Zend_Feed_Writer_Renderer_RendererAbstract
methodpublicsetRootElement( \DOMElement $root ) : void

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

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::setRootElement()
Parameters
Name Type Description
$root \DOMElement
methodpublicsetType( string $type ) : void

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.

Inherited from: \Zend_Feed_Writer_Renderer_RendererAbstract::setType()
Parameters
Name Type Description
$type string
Documentation was generated by DocBlox 0.13.3.