Merge pull request #2 from jeroenmoors/master

Add support for "enclosure" element within Items for Podcasts

Author: suin

README.md

@@ -2,6 +2,8 @@
 
 `\Suin\RSSWriter` is yet another simple RSS writer library for PHP 5.3 or later. This component is Licensed under MIT license.
 
+This library can also be used to publish Podcasts.
+
 The build status of the current master branch is tracked by Travis CI: [![Build Status](https://secure.travis-ci.org/suin/php-rss-writer.png?branch=master)](http://travis-ci.org/suin/php-rss-writer)
 
 
@@ -18,13 +20,23 @@ $channel
 	->url('http://blog.example.com')
 	->appendTo($feed);
 
+// RSS item
 $item = new Item();
 $item
 	->title("Blog Entry Title")
 	->description("<div>Blog body</div>")
 	->url('http://blog.example.com/2012/08/21/blog-entry/')
 	->appendTo($channel);
 
+// Podcast item
+$item = new Item();
+$item
+	->title("Some Podcast Entry")
+	->description("<div>Podcast body</div>")
+	->url('http://podcast.example.com/2012/08/21/podcast-entry/')
+    ->enclosure('http://link-to-audio-file.com/2013/08/21/podcast.mp3', 4889, 'audio/mpeg')
+	->appendTo($channel);
+
 
 echo $feed;
 ```
@@ -81,4 +93,4 @@ If you want to know APIs, please see `FeedInterface`, `ChannelInterface` and `It
 
 ## License
 
-MIT license
+MIT license

Source/Suin/RSSWriter/Item.php

@@ -20,6 +20,8 @@ class Item implements \Suin\RSSWriter\ItemInterface
 	protected $isPermalink;
 	/** @var int */
 	protected $pubDate;
+    /** @var array */
+    protected $enclosure;
 
 	/**
 	 * Set item title
@@ -90,6 +92,19 @@ public function pubDate($pubDate)
 		return $this;
 	}
 
+	/**
+	 * Set enclosure 
+	 * @param var $url Url to media file
+     * @param int $length Length in bytes of the media file
+     * @param var $type Media type, default is audio/mpeg
+	 * @return $this
+	 */
+	public function enclosure($url, $length = 0, $type = 'audio/mpeg')
+	{
+		$this->enclosure = array('url' => $url, 'length' => $length, 'type' => $type);
+		return $this;
+	}
+
 	/**
 	 * Append item to the channel
 	 * @param \Suin\RSSWriter\ChannelInterface $channel
@@ -137,6 +152,18 @@ public function asXML()
 			$xml->addChild('pubDate', date(DATE_RSS, $this->pubDate));
 		}
 
+
+        if (is_array($this->enclosure) && (count($this->enclosure) == 3))
+		{
+			$element = $xml->addChild('enclosure');
+            $element->addAttribute('url', $this->enclosure['url']);
+            $element->addAttribute('type', $this->enclosure['type']);
+            
+            if ($this->enclosure['length']) 
+            {
+                $element->addAttribute('length', $this->enclosure['length']);
+            }
+		}
 		return $xml;
 	}
 }

Source/Suin/RSSWriter/ItemInterface.php

@@ -51,6 +51,15 @@ public function guid($guid, $isPermalink = false);
 	 */
 	public function pubDate($pubDate);
 
+	/**
+	 * Set enclosure 
+	 * @param var $url Url to media file
+     * @param int $length Length in bytes of the media file
+     * @param var $type Media type, default is audio/mpeg
+	 * @return $this
+	 */
+	public function enclosure($url, $length = 0, $type = 'audio/mpeg');
+
 	/**
 	 * Append item to the channel
 	 * @param \Suin\RSSWriter\ChannelInterface $channel

Tests/Suin/RSSWriter/ItemTest.php

@@ -88,6 +88,15 @@ public function testAppendTo()
 		$this->assertSame($item, $item->appendTo($channel));
 	}
 
+	public function testEnclosure()
+	{
+		$url = uniqid();
+        $enclosure = array('url' => $url, 'length' => 0, 'type' => 'audio/mpeg');
+		$item = new Item();
+		$this->assertSame($item, $item->enclosure($url));
+		$this->assertAttributeSame($enclosure, 'enclosure', $item);
+	}
+
 	public function testAsXML()
 	{
 		$now = time();
@@ -104,6 +113,10 @@ public function testAsXML()
 			'guid' => "http://inessential.com/2002/09/01.php#a2",
 			'isPermalink' => true,
 			'pubDate' => $now,
+            'enclosure' => array(
+                'url'    => 'http://link-to-audio-file.com/test.mp3',
+                'length' => 4992,
+                'type'   => 'audio/mpeg')
 		);
 
 		$item = new Item();
@@ -122,6 +135,7 @@ public function testAsXML()
 			<category domain=\"{$data['categories'][1][1]}\">{$data['categories'][1][0]}</category>
 			<guid isPermaLink=\"true\">{$data['guid']}</guid>
 			<pubDate>{$nowString}</pubDate>
+            <enclosure url=\"{$data['enclosure']['url']}\" length=\"{$data['enclosure']['length']}\" type=\"{$data['enclosure']['type']}\"/>
 		</item>
 		";
 		$this->assertXmlStringEqualsXmlString($expect, $item->asXML()->asXML());
@@ -133,7 +147,7 @@ public function testAsXML_test_Japanese()
 		$nowString = date(DATE_RSS, $now);
 
 		$data = array(
-			'title'       => "日本語",
+			'title'       => "Venice Film Festival",
 			'url'         => 'http://nytimes.com/2004/12/07FEST.html',
 			'description' => "Some of the most heated chatter at the Venice Film Festival this week was about the way that the arrival of the stars at the Palazzo del Cinema was being staged.",
 		);