API Documentation

Zend/Feed/Writer/Renderer/RendererInterface.php

Show: inherited
    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: RendererInterface.php 24594 2012-01-05 21:27:01Z matthew $  

    \Zend_Feed_Writer_Renderer_RendererInterface

    Package: Zend\Feed\Writer

    Category
    Zend  
    Copyright
    Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  

    Methods

    methodpublicgetDataContainer( ) : mixed

    Get data container containing feed items

    Returns
    Type Description
    mixed
    methodpublicgetDomDocument( ) : \DOMDocument

    Get DOM document

    Returns
    Type Description
    \DOMDocument
    methodpublicgetElement( ) : \DOMElement

    Get document element from DOM

    Returns
    Type Description
    \DOMElement
    methodpublicgetExceptions( ) : array

    Get list of thrown exceptions

    Returns
    Type Description
    array
    methodpublicgetRootElement( ) : \DOMElement

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

    Returns
    Type Description
    \DOMElement
    methodpublicgetType( ) : string

    Retrieve the current or last feed type exported.

    Returns
    Type Description
    string Value will be "rss" or "atom"
    methodpublicignoreExceptions( ) : mixed

    Should exceptions be ignored?

    Returns
    Type Description
    mixed
    methodpublicrender( ) : void

    Render feed/entry

    methodpublicsaveXml( ) : string

    Save feed and/or entry to XML and return string

    Returns
    Type Description
    string
    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 ;).

    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.

    Parameters
    Name Type Description
    $type string
    Documentation was generated by DocBlox 0.15.1.