Changeset 2293

Timestamp:

12/11/10 07:23:51 (18 months ago)

Author:

petsagouris

Message:

[Branch 1.5] Splitted the RSSWriter class into RSSWriter and RSSItem.
Need to test this one.

Files:

• branches/1.5/libs/extensions/RSSWriterClass/rsswriter.php (modified) (6 diffs)

branches/1.5/libs/extensions/RSSWriterClass/rsswriter.php

@@ -1 +1 @@
 <?php
+/**
+ * RSS class
+ *
+ * @author George Petsagourakis <petsagouris@gmail.com>
+ *
+ * @package HotaruCMS
+ * @subpackage RSS
+ */
 
 /**
  * Publishes content as an RSS feed.
+ *
  * @url: http://snipplr.com/view/23/rss-writer-class/
  * @uses RSSItem
- * @example
- * <code>
+ * @example <code>
  * $feed = new RSS();
  * $feed->title = "RSS Feed Title";
@@ -27 +35 @@
 class RSS {
 
+        /**
+         * The feed's title
+         *
+         * @var string
+         */
         public $title;
+        /**
+         * The feed's URL
+         * 
+         * @var string
+         */
         public $rss_link;
+        /**
+         * The feed's atom link (for caching)
+         *
+         * @var string
+         */
         public $link;
+        /**
+         * The feed's description text
+         *
+         * @var string
+         */
         public $description;
+        /**
+         * The feed's language identifier
+         *
+         * @var string
+         */
         public $language = "en-us";
+        /**
+         * The feed's publication date
+         *
+         * @var string
+         */
         public $pubDate;
+        /**
+         * The feed's items (an array of RSSItem objects)
+         *
+         * @var array
+         */
         public $items = array();
+        /**
+         * Additional tag entries for the parent tag.
+         *
+         * @var array
+         */
         public $tags = array();
 
+        /**
+         * The constructor set's up the object with an initial url of the feed.
+         *
+         * @param string $rss_link the link of the feed
+         */
         public function __construct($rss_link)
         {
@@ -41 +94 @@
         }
 
+        /**
+         * Adds RSSItem objects to the RSS::items array
+         *
+         * @param array $item An array that will be used in constructing the RSSItem object
+         */
         public function addItem($item)
         {
                 if (is_array($item)) {
                         foreach ($item as $i) {
-                                array_push($this->items, new RSSItem($i));
+                                $this->items[] = new RSSItem($i);
                         }
                 }
@@ -51 +109 @@
         }
 
+        /**
+         * Publication date setter for the feed
+         *
+         * @param string $when 
+         */
         public function setPubDate($when)
         {
@@ -56 +119 @@
         }
 
+        /**
+         *
+         * @param <type> $tag
+         * @param <type> $value
+         */
         public function addTag($tag, $value)
         {
@@ -98 +166 @@
 
 }
-
-/**
- * Represents an item on the RSS feed.
- * @see RSS
- */
-class RSSItem {
-
-        public $title;
-        public $link;
-        public $description;
-        public $pubDate;
-        public $guid;
-        public $tags = array();
-        public $attachment;
-        public $length;
-        public $mimetype;
-
-        public function __construct($options)
-        {
-                if (isset($options['title'])) {
-                        $this->title = stripslashes(html_entity_decode(urldecode($options['title']), ENT_QUOTES, 'UTF-8'));
-                }
-
-                if (isset($options['link'])) {
-                        $this->link = html_entity_decode($options['link'], ENT_QUOTES, 'UTF-8');
-                }
-
-                if (isset($options['date'])) {
-                        $this->pubDate = date("D, d M Y H:i:s O", ((strtotime($options['date'])) ? strtotime($options['date']) : $options['date']));
-                }
-
-                if (isset($options['description'])) {
-                        $this->description = "<![CDATA[ ".stripslashes(urldecode($options['description']))." ]]>";
-                }
-
-                if (isset($options['enclosure'])) {
-                        $this->attachment = $options['enclosure']['url'];
-                        $this->mimetype = $options['enclosure']['type'];
-                        $this->length = $options['enclosure']['length'];
-                }
-
-                if (isset($options['author'])) {
-                        $this->tags['author'] = $options['author'];
-                }
-        }
-
-        public function out()
-        {
-                $out = "<item>\n";
-                $out .= "<title>".$this->title."</title>\n";
-                $out .= "<link>".$this->link."</link>\n";
-                $out .= "<description>".$this->description."</description>\n";
-                $out .= "<pubDate>".((empty($this->pubDate)) ? date("D, d M Y H:i:s O") : $this->pubDate)."</pubDate>\n";
-
-                if (!empty($this->attachment)) {
-                        $out .= "<enclosure url='{$this->attachment}' length='{$this->length}' type='{$this->mimetype}' />";
-                }
-
-                $this->guid = (empty($this->guid)) ? $this->link : $this->guid;
-
-                $out .= "<guid>".$this->guid."</guid>\n";
-
-                foreach ($this->tags as $key => $val) {
-                        $out .= "<$key>$val</$key\n>";
-                }
-
-                return $out."</item>\n";
-        }
-
-}