<?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

 * @package    Zend_Feed_Writer

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: RendererInterface.php 20096 2010-01-06 02:05:09Z bkarwin $

 */

/**

 * @category   Zend

 * @package    Zend_Feed_Writer

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

interface Zend_Feed_Writer_Renderer_RendererInterface

{

    /**

     * Render feed/entry

     * 

     * @return void

     */

    public function render();

    /**

     * Save feed and/or entry to XML and return string

     * 

     * @return string

     */

    public function saveXml();

    /**

     * Get DOM document

     * 

     * @return DOMDocument

     */

    public function getDomDocument();

    /**

     * Get document element from DOM

     * 

     * @return DOMElement

     */

    public function getElement();

    /**

     * Get data container containing feed items

     * 

     * @return mixed

     */

    public function getDataContainer();

    /**

     * Should exceptions be ignored?

     * 

     * @return mixed

     */

    public function ignoreExceptions();

    /**

     * Get list of thrown exceptions

     * 

     * @return array

     */

    public function getExceptions();

    /**

     * 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.

     *

     * @param string $type

     */

    public function setType($type);

    /**

     * Retrieve the current or last feed type exported.

     *

     * @return string Value will be "rss" or "atom"

     */

    public function getType();

    /**

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

     *

     * @param DOMElement $root

     */

    public function setRootElement(DOMElement $root);

    /**

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

     *

     * @return DOMElement

     */

    public function getRootElement();

}