web/lib/Zend/Feed/Writer/Renderer/RendererAbstract.php
changeset 64 162c1de6545a
parent 19 1c2f13fd785c
child 68 ecaf28ffe26e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/web/lib/Zend/Feed/Writer/Renderer/RendererAbstract.php	Fri Mar 11 15:05:35 2011 +0100
@@ -0,0 +1,250 @@
+<?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: RendererAbstract.php 20096 2010-01-06 02:05:09Z bkarwin $
+ */
+ 
+/** @see Zend_Feed_Writer */
+require_once 'Zend/Feed/Writer.php';
+
+/** @see Zend_Version */
+require_once 'Zend/Version.php';
+ 
+/**
+ * @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
+ */
+class Zend_Feed_Writer_Renderer_RendererAbstract
+{
+    /**
+     * Extensions
+     * @var array
+     */
+    protected $_extensions = array();
+    
+    /**
+     * @var mixed
+     */
+    protected $_container = null;
+
+    /**
+     * @var DOMDocument
+     */
+    protected $_dom = null;
+
+    /**
+     * @var bool
+     */
+    protected $_ignoreExceptions = false;
+
+    /**
+     * @var array
+     */
+    protected $_exceptions = array();
+    
+    /**
+     * Encoding of all text values
+     *
+     * @var string
+     */
+    protected $_encoding = 'UTF-8';
+    
+    /**
+     * Holds the value "atom" or "rss" depending on the feed type set when
+     * when last exported.
+     *
+     * @var string
+     */
+    protected $_type = null;
+    
+    /**
+     * @var DOMElement
+     */
+    protected $_rootElement = null;
+
+    /**
+     * Constructor
+     * 
+     * @param  mixed $container 
+     * @return void
+     */
+    public function __construct($container)
+    {
+        $this->_container = $container;
+        $this->setType($container->getType());
+        $this->_loadExtensions();
+    }
+    
+    /**
+     * Save XML to string
+     * 
+     * @return string
+     */
+    public function saveXml()
+    {
+        return $this->getDomDocument()->saveXml();
+    }
+
+    /**
+     * Get DOM document
+     * 
+     * @return DOMDocument
+     */
+    public function getDomDocument()
+    {
+        return $this->_dom;
+    }
+
+    /**
+     * Get document element from DOM
+     * 
+     * @return DOMElement
+     */
+    public function getElement()
+    {
+        return $this->getDomDocument()->documentElement;
+    }
+
+    /**
+     * Get data container of items being rendered
+     * 
+     * @return mixed
+     */
+    public function getDataContainer()
+    {
+        return $this->_container;
+    }
+    
+    /**
+     * Set feed encoding
+     * 
+     * @param  string $enc 
+     * @return Zend_Feed_Writer_Renderer_RendererAbstract
+     */
+    public function setEncoding($enc)
+    {
+        $this->_encoding = $enc;
+        return $this;
+    }
+    
+    /**
+     * Get feed encoding
+     * 
+     * @return string
+     */
+    public function getEncoding()
+    {
+        return $this->_encoding;
+    }
+
+    /**
+     * Indicate whether or not to ignore exceptions
+     * 
+     * @param  bool $bool 
+     * @return Zend_Feed_Writer_Renderer_RendererAbstract
+     */
+    public function ignoreExceptions($bool = true)
+    {
+        if (!is_bool($bool)) {
+            require_once 'Zend/Feed/Exception.php';
+            throw new Zend_Feed_Exception('Invalid parameter: $bool. Should be TRUE or FALSE (defaults to TRUE if null)');
+        }
+        $this->_ignoreExceptions = $bool;
+        return $this;
+    }
+
+    /**
+     * Get exception list
+     * 
+     * @return array
+     */
+    public function getExceptions()
+    {
+        return $this->_exceptions;
+    }
+    
+    /**
+     * 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)
+    {
+        $this->_type = $type;
+    }
+    
+    /**
+     * Retrieve the current or last feed type exported.
+     *
+     * @return string Value will be "rss" or "atom"
+     */
+    public function getType()
+    {
+        return $this->_type;
+    }
+    
+    /**
+     * 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)
+    {
+        $this->_rootElement = $root;
+    }
+    
+    /**
+     * Retrieve the absolute root element for the XML feed being generated.
+     *
+     * @return DOMElement
+     */
+    public function getRootElement()
+    {
+        return $this->_rootElement;
+    }
+    
+    /**
+     * Load extensions from Zend_Feed_Writer
+     *
+     * @return void
+     */
+    protected function _loadExtensions()
+    {
+        Zend_Feed_Writer::registerCoreExtensions();
+        $all = Zend_Feed_Writer::getExtensions();
+        if (stripos(get_class($this), 'entry')) {
+            $exts = $all['entryRenderer'];
+        } else {
+            $exts = $all['feedRenderer'];
+        }
+        foreach ($exts as $extension) {
+            $className = Zend_Feed_Writer::getPluginLoader()->getClassName($extension);
+            $this->_extensions[$extension] = new $className(
+                $this->getDataContainer()
+            );
+            $this->_extensions[$extension]->setEncoding($this->getEncoding());
+        }
+    }
+}