API Documentation

Feed/Writer/Renderer/RendererInterface.php

Interfaces
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Feed_Writer
version
$Id: RendererInterface.php 20096 2010-01-06 02:05:09Z bkarwin $
Interfaces
Zend_Feed_Writer_Renderer_RendererInterface

Description

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.

Zend_Feed_Writer_Renderer_RendererInterface
jump to top

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Feed_Writer
Methods
render
saveXml
getDomDocument
getElement
getDataContainer
ignoreExceptions
getExceptions
setType
getType
setRootElement
getRootElement

Description

Methods

getDataContainer
jump to class

getDataContainer( ) : mixed

Get data container containing feed items

Output
mixed
Details
visibility
public
final
false
static
false

getDomDocument
jump to class

getDomDocument( ) : DOMDocument

Get DOM document

Output
DOMDocument
Details
visibility
public
final
false
static
false

getElement
jump to class

getElement( ) : DOMElement

Get document element from DOM

Output
DOMElement
Details
visibility
public
final
false
static
false

getExceptions
jump to class

getExceptions( ) : array

Get list of thrown exceptions

Output
array
Details
visibility
public
final
false
static
false

getRootElement
jump to class

getRootElement( ) : DOMElement

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

Output
DOMElement
Details
visibility
public
final
false
static
false

getType
jump to class

getType( ) : string

Retrieve the current or last feed type exported.

Output
string
Value will be "rss" or "atom"
Details
visibility
public
final
false
static
false

ignoreExceptions
jump to class

ignoreExceptions( ) : mixed

Should exceptions be ignored?

Output
mixed
Details
visibility
public
final
false
static
false

render
jump to class

render( ) : void

Render feed/entry

Details
visibility
public
final
false
static
false

saveXml
jump to class

saveXml( ) : string

Save feed and/or entry to XML and return string

Output
string
Details
visibility
public
final
false
static
false

setRootElement
jump to class

setRootElement( DOMElement $root ) :

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

Arguments
$root
DOMElement
Details
visibility
public
final
false
static
false

setType
jump to class

setType( string $type ) :

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.

Arguments
$type
string
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.