web/lib/Zend/Feed/Writer/Renderer/Entry/Rss.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/Entry/Rss.php	Fri Mar 11 15:05:35 2011 +0100
@@ -0,0 +1,346 @@
+<?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: Rss.php 22064 2010-04-30 14:02:38Z padraic $
+ */
+
+/**
+ * @see Zend_Feed_Writer_Renderer_RendererAbstract
+ */
+require_once 'Zend/Feed/Writer/Renderer/RendererAbstract.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_Entry_Rss
+    extends Zend_Feed_Writer_Renderer_RendererAbstract
+    implements Zend_Feed_Writer_Renderer_RendererInterface
+{
+    /**
+     * Constructor
+     * 
+     * @param  Zend_Feed_Writer_Entry $container 
+     * @return void
+     */
+    public function __construct (Zend_Feed_Writer_Entry $container)
+    {
+        parent::__construct($container);
+    }
+    
+    /**
+     * Render RSS entry
+     * 
+     * @return Zend_Feed_Writer_Renderer_Entry_Rss
+     */
+    public function render()
+    {
+        $this->_dom = new DOMDocument('1.0', $this->_container->getEncoding());
+        $this->_dom->formatOutput = true;
+        $this->_dom->substituteEntities = false;
+        $entry = $this->_dom->createElement('item');
+        $this->_dom->appendChild($entry);
+        
+        $this->_setTitle($this->_dom, $entry);
+        $this->_setDescription($this->_dom, $entry);
+        $this->_setDateCreated($this->_dom, $entry);
+        $this->_setDateModified($this->_dom, $entry);
+        $this->_setLink($this->_dom, $entry);
+        $this->_setId($this->_dom, $entry);
+        $this->_setAuthors($this->_dom, $entry);
+        $this->_setEnclosure($this->_dom, $entry);
+        $this->_setCommentLink($this->_dom, $entry);
+        $this->_setCategories($this->_dom, $entry);
+        foreach ($this->_extensions as $ext) {
+            $ext->setType($this->getType());
+            $ext->setRootElement($this->getRootElement());
+            $ext->setDomDocument($this->getDomDocument(), $entry);
+            $ext->render();
+        }
+
+        return $this;
+    }
+    
+    /**
+     * Set entry title
+     * 
+     * @param  DOMDocument $dom 
+     * @param  DOMElement $root 
+     * @return void
+     */
+    protected function _setTitle(DOMDocument $dom, DOMElement $root)
+    {
+        if(!$this->getDataContainer()->getDescription()
+        && !$this->getDataContainer()->getTitle()) {
+            require_once 'Zend/Feed/Exception.php';
+            $message = 'RSS 2.0 entry elements SHOULD contain exactly one'
+            . ' title element but a title has not been set. In addition, there'
+            . ' is no description as required in the absence of a title.';
+            $exception = new Zend_Feed_Exception($message);
+            if (!$this->_ignoreExceptions) {
+                throw $exception;
+            } else {
+                $this->_exceptions[] = $exception;
+                return;
+            }
+        }
+        $title = $dom->createElement('title');
+        $root->appendChild($title);
+        $text = $dom->createTextNode($this->getDataContainer()->getTitle());
+        $title->appendChild($text);
+    }
+    
+    /**
+     * Set entry description
+     * 
+     * @param  DOMDocument $dom 
+     * @param  DOMElement $root 
+     * @return void
+     */
+    protected function _setDescription(DOMDocument $dom, DOMElement $root)
+    {
+        if(!$this->getDataContainer()->getDescription()
+        && !$this->getDataContainer()->getTitle()) {
+            require_once 'Zend/Feed/Exception.php';
+            $message = 'RSS 2.0 entry elements SHOULD contain exactly one'
+            . ' description element but a description has not been set. In'
+            . ' addition, there is no title element as required in the absence'
+            . ' of a description.';
+            $exception = new Zend_Feed_Exception($message);
+            if (!$this->_ignoreExceptions) {
+                throw $exception;
+            } else {
+                $this->_exceptions[] = $exception;
+                return;
+            }
+        }
+        if (!$this->getDataContainer()->getDescription()) {
+            return;
+        }
+        $subtitle = $dom->createElement('description');
+        $root->appendChild($subtitle);
+        $text = $dom->createCDATASection($this->getDataContainer()->getDescription());
+        $subtitle->appendChild($text);
+    }
+    
+    /**
+     * Set date entry was last modified
+     * 
+     * @param  DOMDocument $dom 
+     * @param  DOMElement $root 
+     * @return void
+     */
+    protected function _setDateModified(DOMDocument $dom, DOMElement $root)
+    {
+        if(!$this->getDataContainer()->getDateModified()) {
+            return;
+        }
+
+        $updated = $dom->createElement('pubDate');
+        $root->appendChild($updated);
+        $text = $dom->createTextNode(
+            $this->getDataContainer()->getDateModified()->get(Zend_Date::RSS)
+        );
+        $updated->appendChild($text);
+    }
+    
+    /**
+     * Set date entry was created
+     * 
+     * @param  DOMDocument $dom 
+     * @param  DOMElement $root 
+     * @return void
+     */
+    protected function _setDateCreated(DOMDocument $dom, DOMElement $root)
+    {
+        if (!$this->getDataContainer()->getDateCreated()) {
+            return;
+        }
+        if (!$this->getDataContainer()->getDateModified()) {
+            $this->getDataContainer()->setDateModified(
+                $this->getDataContainer()->getDateCreated()
+            );
+        }
+    }
+    
+    /**
+     * Set entry authors
+     * 
+     * @param  DOMDocument $dom 
+     * @param  DOMElement $root 
+     * @return void
+     */
+    protected function _setAuthors(DOMDocument $dom, DOMElement $root)
+    {
+        $authors = $this->_container->getAuthors();
+        if ((!$authors || empty($authors))) {
+            return;
+        }
+        foreach ($authors as $data) {
+            $author = $this->_dom->createElement('author');
+            $name = $data['name'];
+            if (array_key_exists('email', $data)) {
+                $name = $data['email'] . ' (' . $data['name'] . ')';
+            }
+            $text = $dom->createTextNode($name);
+            $author->appendChild($text);
+            $root->appendChild($author);
+        }
+    }
+    
+    /**
+     * Set entry enclosure
+     * 
+     * @param  DOMDocument $dom 
+     * @param  DOMElement $root 
+     * @return void
+     */
+    protected function _setEnclosure(DOMDocument $dom, DOMElement $root)
+    {
+        $data = $this->_container->getEnclosure();
+        if ((!$data || empty($data))) {
+            return;
+        }
+        if (!isset($data['type'])) {
+            require_once 'Zend/Feed/Exception.php';
+            $exception = new Zend_Feed_Exception('Enclosure "type" is not set');
+            if (!$this->_ignoreExceptions) {
+                throw $exception;
+            } else {
+                $this->_exceptions[] = $exception;
+                return;
+            }
+        }
+        if (!isset($data['length'])) {
+            require_once 'Zend/Feed/Exception.php';
+            $exception = new Zend_Feed_Exception('Enclosure "length" is not set');
+            if (!$this->_ignoreExceptions) {
+                throw $exception;
+            } else {
+                $this->_exceptions[] = $exception;
+                return;
+            }
+        }
+        if (isset($data['length']) && (int) $data['length'] <= 0) {
+            require_once 'Zend/Feed/Exception.php';
+            $exception = new Zend_Feed_Exception('Enclosure "length" must be an integer'
+            . ' indicating the content\'s length in bytes');
+            if (!$this->_ignoreExceptions) {
+                throw $exception;
+            } else {
+                $this->_exceptions[] = $exception;
+                return;
+            }
+        }
+        $enclosure = $this->_dom->createElement('enclosure');
+        $enclosure->setAttribute('type', $data['type']);
+        $enclosure->setAttribute('length', $data['length']);
+        $enclosure->setAttribute('url', $data['uri']);
+        $root->appendChild($enclosure);
+    }
+    
+    /**
+     * Set link to entry
+     * 
+     * @param  DOMDocument $dom 
+     * @param  DOMElement $root 
+     * @return void
+     */
+    protected function _setLink(DOMDocument $dom, DOMElement $root)
+    {
+        if(!$this->getDataContainer()->getLink()) {
+            return;
+        }
+        $link = $dom->createElement('link');
+        $root->appendChild($link);
+        $text = $dom->createTextNode($this->getDataContainer()->getLink());
+        $link->appendChild($text);
+    }
+    
+    /**
+     * Set entry identifier
+     * 
+     * @param  DOMDocument $dom 
+     * @param  DOMElement $root 
+     * @return void
+     */
+    protected function _setId(DOMDocument $dom, DOMElement $root)
+    {
+        if(!$this->getDataContainer()->getId()
+        && !$this->getDataContainer()->getLink()) {
+            return;
+        }
+
+        $id = $dom->createElement('guid');
+        $root->appendChild($id);
+        if (!$this->getDataContainer()->getId()) {
+            $this->getDataContainer()->setId(
+                $this->getDataContainer()->getLink());
+        }
+        $text = $dom->createTextNode($this->getDataContainer()->getId());
+        $id->appendChild($text);
+        if (!Zend_Uri::check($this->getDataContainer()->getId())) {
+            $id->setAttribute('isPermaLink', 'false');
+        }
+    }
+    
+    /**
+     * Set link to entry comments
+     * 
+     * @param  DOMDocument $dom 
+     * @param  DOMElement $root 
+     * @return void
+     */
+    protected function _setCommentLink(DOMDocument $dom, DOMElement $root)
+    {
+        $link = $this->getDataContainer()->getCommentLink();
+        if (!$link) {
+            return;
+        }
+        $clink = $this->_dom->createElement('comments');
+        $text = $dom->createTextNode($link);
+        $clink->appendChild($text);
+        $root->appendChild($clink);
+    }
+    
+    /**
+     * Set entry categories
+     * 
+     * @param DOMDocument $dom 
+     * @param DOMElement $root 
+     * @return void
+     */
+    protected function _setCategories(DOMDocument $dom, DOMElement $root)
+    {
+        $categories = $this->getDataContainer()->getCategories();
+        if (!$categories) {
+            return;
+        }
+        foreach ($categories as $cat) {
+            $category = $dom->createElement('category');
+            if (isset($cat['scheme'])) {
+                $category->setAttribute('domain', $cat['scheme']);
+            }
+            $text = $dom->createCDATASection($cat['term']);
+            $category->appendChild($text);
+            $root->appendChild($category);
+        }
+    }
+}