Merge pull request #86 from ruudvdd/element-aware-interface-refactor

Refactor node and element implement a ElementsAwareInterface interface for type checking

src/FeedIo/Feed/ElementsAwareInterface.php

@@ -0,0 +1,57 @@
+<?php
+/*
+ * This file is part of the feed-io package.
+ *
+ * (c) Alexandre Debril <alex.debril@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FeedIo\Feed;
+
+use FeedIo\Feed\Node\ElementInterface;
+use FeedIo\Feed\Node\ElementIterator;
+
+interface ElementsAwareInterface
+{
+    /**
+     * @return ElementInterface
+     */
+    public function newElement();
+
+    /**
+     * @param  string $name element name
+     * @return ElementIterator
+     */
+    public function getElementIterator($name);
+
+    /**
+     * @param  string $name element name
+     * @return boolean true if the element exists
+     */
+    public function hasElement($name);
+
+    /**
+     * @param  ElementInterface $element
+     * @return $this
+     */
+    public function addElement(ElementInterface $element);
+
+    /**
+     * Returns all the item's optional elements
+     * @return \ArrayIterator
+     */
+    public function getAllElements();
+
+    /**
+     * Returns the item's optional elements tag names
+     * @return array
+     */
+    public function listElements();
+
+    /**
+     * @return \Generator
+     */
+    public function getElementsGenerator();
+}

src/FeedIo/Feed/ElementsAwareTrait.php

@@ -37,19 +37,6 @@ public function newElement()
         return new Element();
     }
 
-    /**
-     * @param  string $name element name
-     * @return mixed
-     */
-    public function getValue($name)
-    {
-        foreach ($this->getElementIterator($name) as $element) {
-            return $element->getValue();
-        }
-
-        return;
-    }
-
     /**
      * @param  string $name element name
      * @return ElementIterator

src/FeedIo/Feed/Node.php

@@ -13,10 +13,10 @@
 use FeedIo\Feed\Node\Category;
 use FeedIo\Feed\Node\CategoryInterface;
 
-class Node implements NodeInterface
+class Node implements NodeInterface, ElementsAwareInterface
 {
     use ElementsAwareTrait;
-    
+
     /**
      * @var \ArrayIterator
      */
@@ -208,6 +208,19 @@ public function setLink($link)
         return $this;
     }
 
+    /**
+     * @param  string $name element name
+     * @return mixed
+     */
+    public function getValue($name)
+    {
+        foreach ($this->getElementIterator($name) as $element) {
+            return $element->getValue();
+        }
+
+        return;
+    }
+
     /**
      * @return array
      */

src/FeedIo/Feed/Node/Element.php

@@ -10,9 +10,10 @@
 
 namespace FeedIo\Feed\Node;
 
+use FeedIo\Feed\ElementsAwareInterface;
 use FeedIo\Feed\ElementsAwareTrait;
 
-class Element implements ElementInterface
+class Element implements ElementInterface, ElementsAwareInterface
 {
     use ElementsAwareTrait;
 

src/FeedIo/Feed/Node/ElementInterface.php

@@ -73,42 +73,4 @@ public function getAttributes();
      * @return $this
      */
     public function setAttribute($name, $value);
-
-    /**
-     * returns the ElementIterator to iterate over ElementInterface instances called $name
-     *
-     * @param  string $name element name
-     * @return \FeedIo\Feed\Node\ElementIterator
-     */
-    public function getElementIterator($name);
-
-    /**
-     * returns true if an ElementInterface instance called $name exists
-     *
-     * @param  string $name element name
-     * @return boolean true if the element exists
-     */
-    public function hasElement($name);
-
-    /**
-     * adds $element to the object's attributes
-     *
-     * @param  ElementInterface $element
-     * @return $this
-     */
-    public function addElement(ElementInterface $element);
-
-    /**
-     * Returns all the item's elements
-     *
-     * @return \ArrayIterator
-     */
-    public function getAllElements();
-
-    /**
-     * Returns the item's elements tag names
-     *
-     * @return array
-     */
-    public function listElements();
 }

src/FeedIo/Feed/NodeInterface.php

@@ -117,13 +117,6 @@ public function addCategory(CategoryInterface $category);
      */
     public function newCategory();
 
-    /**
-     * returns a new ElementInterface
-     *
-     * @return \FeedIo\Feed\Node\ElementInterface
-     */
-    public function newElement();
-
     /**
      * returns an element's value
      *
@@ -140,42 +133,4 @@ public function getValue($name);
      * @return $this
      */
     public function set($name, $value);
-
-    /**
-     * returns the ElementIterator to iterate over ElementInterface instances called $name
-     *
-     * @param  string                            $name element name
-     * @return \FeedIo\Feed\Node\ElementIterator
-     */
-    public function getElementIterator($name);
-
-    /**
-     * returns true if an ElementInterface instance called $name exists
-     *
-     * @param  string  $name element name
-     * @return boolean true if the element exists
-     */
-    public function hasElement($name);
-
-    /**
-     * adds $element to the object's attributes
-     *
-     * @param  ElementInterface $element
-     * @return $this
-     */
-    public function addElement(ElementInterface $element);
-
-    /**
-     * Returns all the item's elements
-     *
-     * @return \ArrayIterator
-     */
-    public function getAllElements();
-
-    /**
-     * Returns the item's elements tag names
-     *
-     * @return array
-     */
-    public function listElements();
 }