Allow CDATA for title and description #16

Signed-off-by: Hidehito Nozawa <[email protected]>

Author: suin

Makefile

@@ -0,0 +1,5 @@
+test:
+	docker-compose up php54
+	docker-compose up php55
+	docker-compose up php56
+	docker-compose up php70

README.md

@@ -33,12 +33,13 @@ $channel
 $item = new Item();
 $item
     ->title('Blog Entry Title')
-    ->description('Blog body')
+    ->description('<div>Blog body</div>')
     ->contentEncoded('<div>Blog body</div>')
     ->url('http://blog.example.com/2012/08/21/blog-entry/')
     ->author('Hidehito Nozawa')
     ->pubDate(strtotime('Tue, 21 Aug 2012 19:50:37 +0900'))
     ->guid('http://blog.example.com/2012/08/21/blog-entry/', true)
+    ->preferCdata(true) // By this, title and description become CDATA wrapped HTML.
     ->appendTo($channel);
 
 // Podcast item
@@ -68,9 +69,9 @@ Output:
     <lastBuildDate>Tue, 21 Aug 2012 10:50:37 +0000</lastBuildDate>
     <ttl>60</ttl>
     <item xmlns:default="http://purl.org/rss/1.0/modules/content/">
-      <title>Blog Entry Title</title>
+      <title><![CDATA[Blog Entry Title]]></title>
       <link>http://blog.example.com/2012/08/21/blog-entry/</link>
-      <description>Blog body</description>
+      <description><![CDATA[<div>Blog body</div>]]></description>
       <content:encoded xmlns="http://purl.org/rss/1.0/modules/content/"><![CDATA[<div>Blog body</div>]]></content:encoded>
       <guid>http://blog.example.com/2012/08/21/blog-entry/</guid>
       <pubDate>Tue, 21 Aug 2012 10:50:37 +0000</pubDate>

examples/simple-feed.php

@@ -28,12 +28,13 @@
 $item = new Item();
 $item
     ->title('Blog Entry Title')
-    ->description('Blog body')
+    ->description('<div>Blog body</div>')
     ->contentEncoded('<div>Blog body</div>')
     ->url('http://blog.example.com/2012/08/21/blog-entry/')
     ->author('Hidehito Nozawa')
     ->pubDate(strtotime('Tue, 21 Aug 2012 19:50:37 +0900'))
     ->guid('http://blog.example.com/2012/08/21/blog-entry/', true)
+    ->preferCdata(true) // By this, title and description become CDATA wrapped HTML.
     ->appendTo($channel);
 
 // Podcast item

src/Suin/RSSWriter/Item.php

@@ -38,6 +38,8 @@ class Item implements ItemInterface
     /** @var string */
     protected $author;
 
+    protected $preferCdata = false;
+
     public function title($title)
     {
         $this->title = $title;
@@ -93,6 +95,12 @@ public function author($author)
         return $this;
     }
 
+    public function preferCdata($preferCdata)
+    {
+        $this->preferCdata = (bool)$preferCdata;
+        return $this;
+    }
+
     public function appendTo(ChannelInterface $channel)
     {
         $channel->addItem($this);
@@ -102,16 +110,23 @@ public function appendTo(ChannelInterface $channel)
     public function asXML()
     {
         $xml = new SimpleXMLElement('<?xml version="1.0" encoding="UTF-8" ?><item></item>', LIBXML_NOERROR | LIBXML_ERR_NONE | LIBXML_ERR_FATAL);
-        $xml->addChild('title', $this->title);
+
+        if ($this->preferCdata) {
+            $xml->addCdataChild('title', $this->title);
+        } else {
+            $xml->addChild('title', $this->title);
+        }
+
         $xml->addChild('link', $this->url);
-        $xml->addChild('description', $this->description);
+
+        if ($this->preferCdata) {
+            $xml->addCdataChild('description', $this->description);
+        } else {
+            $xml->addChild('description', $this->description);
+        }
 
         if ($this->contentEncoded) {
-            // SimpleXMLElement does not support CDATA transformation
-            $element = $xml->addChild('encoded', null, 'http://purl.org/rss/1.0/modules/content/');
-            $element = dom_import_simplexml($element);
-            $elementOwner = $element->ownerDocument;
-            $element->appendChild($elementOwner->createCDATASection($this->contentEncoded));
+            $xml->addCdataChild('encoded', $this->contentEncoded, 'http://purl.org/rss/1.0/modules/content/');
         }
 
         foreach ($this->categories as $category) {

src/Suin/RSSWriter/SimpleXMLElement.php

@@ -16,4 +16,12 @@ public function addChild($name, $value = null, $namespace = null)
 
         return parent::addChild($name, $value, $namespace);
     }
+
+    public function addCdataChild($name, $value = null, $namespace = null)
+    {
+        $element = $this->addChild($name, null, $namespace);
+        $element = dom_import_simplexml($element);
+        $elementOwner = $element->ownerDocument;
+        $element->appendChild($elementOwner->createCDATASection($value));
+    }
 }

tests/Suin/RSSWriter/ItemTest.php

@@ -135,6 +135,34 @@ public function testAuthor()
         $this->assertAttributeSame($author, 'author', $item);
     }
 
+    public function testPreferCdata()
+    {
+        $item = new Item();
+        $item->title('<h1>title</h1>');
+        $item->description('<p>description</p>');
+
+        // By default, prefer no CDATA on title and description
+        $actualXml = $item->asXML()->asXML();
+        $this->assertContains('<title>&lt;h1&gt;title&lt;/h1&gt;</title>', $actualXml);
+        $this->assertContains('<description>&lt;p&gt;description&lt;/p&gt;</description>', $actualXml);
+
+        // Once prefer-cdata is enabled, title and description is wrapped by CDATA
+        $item->preferCdata(true);
+        $actualXml = $item->asXML()->asXML();
+        $this->assertContains('<title><![CDATA[<h1>title</h1>]]></title>', $actualXml);
+        $this->assertContains('<description><![CDATA[<p>description</p>]]></description>', $actualXml);
+
+        // Of course, prefer-cdata can be disabled again
+        $item->preferCdata(false);
+        $actualXml = $item->asXML()->asXML();
+        $this->assertContains('<title>&lt;h1&gt;title&lt;/h1&gt;</title>', $actualXml);
+        $this->assertContains('<description>&lt;p&gt;description&lt;/p&gt;</description>', $actualXml);
+
+        // And like other APIs `preferCdata` is also fluent interface
+        $obj = $item->preferCdata(true);
+        $this->assertSame($obj, $item);
+    }
+
     public function testAsXML()
     {
         $now = time();