aleph1.co.uk Git - yaffs-website/blob - vendor/zendframework/zend-feed/src/Writer/Renderer/RendererInterface.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Feed\Writer\Renderer;
  11
  12 use DOMDocument;
  13 use DOMElement;
  14
  15 /**
  16 */
  17 interface RendererInterface
  18 {
  19     /**
  20      * Render feed/entry
  21      *
  22      * @return void
  23      */
  24     public function render();
  25
  26     /**
  27      * Save feed and/or entry to XML and return string
  28      *
  29      * @return string
  30      */
  31     public function saveXml();
  32
  33     /**
  34      * Get DOM document
  35      *
  36      * @return DOMDocument
  37      */
  38     public function getDomDocument();
  39
  40     /**
  41      * Get document element from DOM
  42      *
  43      * @return DOMElement
  44      */
  45     public function getElement();
  46
  47     /**
  48      * Get data container containing feed items
  49      *
  50      * @return mixed
  51      */
  52     public function getDataContainer();
  53
  54     /**
  55      * Should exceptions be ignored?
  56      *
  57      * @return mixed
  58      */
  59     public function ignoreExceptions();
  60
  61     /**
  62      * Get list of thrown exceptions
  63      *
  64      * @return array
  65      */
  66     public function getExceptions();
  67
  68     /**
  69      * Set the current feed type being exported to "rss" or "atom". This allows
  70      * other objects to gracefully choose whether to execute or not, depending
  71      * on their appropriateness for the current type, e.g. renderers.
  72      *
  73      * @param string $type
  74      */
  75     public function setType($type);
  76
  77     /**
  78      * Retrieve the current or last feed type exported.
  79      *
  80      * @return string Value will be "rss" or "atom"
  81      */
  82     public function getType();
  83
  84     /**
  85      * Sets the absolute root element for the XML feed being generated. This
  86      * helps simplify the appending of namespace declarations, but also ensures
  87      * namespaces are added to the root element - not scattered across the entire
  88      * XML file - may assist namespace unsafe parsers and looks pretty ;).
  89      *
  90      * @param DOMElement $root
  91      */
  92     public function setRootElement(DOMElement $root);
  93
  94     /**
  95      * Retrieve the absolute root element for the XML feed being generated.
  96      *
  97      * @return DOMElement
  98      */
  99     public function getRootElement();
 100 }