Merge pull request #193 from symfony-cmf/add-child-cleanup

cleanup addChild method

Author: lsmith77

CHANGELOG.md

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+1.2.x
+-----
+
+* **2014-05-21**: [BC BREAK when extending BaseMenuNode] addChild and
+  removeChild now accepts every Knp\Menu\NodeInterface instead of only
+  MenuNode.
+
 1.1.1
 -----
 

Doctrine/Phpcr/Menu.php

@@ -12,8 +12,8 @@
 namespace Symfony\Cmf\Bundle\MenuBundle\Doctrine\Phpcr;
 
 use Doctrine\ODM\PHPCR\HierarchyInterface;
+use Knp\Menu\NodeInterface;
 use Symfony\Cmf\Bundle\MenuBundle\Model\Menu as ModelMenu;
-use Symfony\Cmf\Bundle\MenuBundle\Model\MenuNode as ModelMenuNode;
 
 class Menu extends ModelMenu implements HierarchyInterface
 {
@@ -58,11 +58,11 @@ public function setPosition($parent, $name)
     /**
      * Add a child menu node, automatically setting the parent node.
      *
-     * @param ModelMenuNode $child
+     * @param NodeInterface $child
      *
-     * @return ModelMenuNode - The newly added child node.
+     * @return NodeInterface - The newly added child node.
      */
-    public function addChild(ModelMenuNode $child)
+    public function addChild(NodeInterface $child)
     {
         if ($child instanceof MenuNode) {
             $child->setParentObject($this);

Doctrine/Phpcr/MenuNode.php

@@ -12,6 +12,7 @@
 namespace Symfony\Cmf\Bundle\MenuBundle\Doctrine\Phpcr;
 
 use Doctrine\ODM\PHPCR\HierarchyInterface;
+use Knp\Menu\NodeInterface;
 use Symfony\Cmf\Bundle\MenuBundle\Model\MenuNode as ModelMenuNode;
 
 class MenuNode extends ModelMenuNode implements HierarchyInterface
@@ -57,11 +58,11 @@ public function setPosition($parent, $name)
     /**
      * Add a child menu node, automatically setting the parent node.
      *
-     * @param ModelMenuNode $child
+     * @param NodeInterface $child
      *
-     * @return ModelMenuNode - The newly added child node.
+     * @return NodeInterface - The newly added child node.
      */
-    public function addChild(ModelMenuNode $child)
+    public function addChild(NodeInterface $child)
     {
         if ($child instanceof MenuNode) {
             $child->setParentObject($this);

Model/MenuNodeBase.php

@@ -365,11 +365,11 @@ public function getChildren()
     /**
      * Add a child menu node under this node.
      *
-     * @param MenuNode $child
+     * @param NodeInterface $child
      *
-     * @return MenuNode The newly added child node.
+     * @return NodeInterface The newly added child node.
      */
-    public function addChild(MenuNode $child)
+    public function addChild(NodeInterface $child)
     {
         $this->children[] = $child;
 
@@ -379,13 +379,15 @@ public function addChild(MenuNode $child)
     /**
      * Remove a child menu node
      *
-     * @param MenuNode $child
+     * @param NodeInterface $child
      *
      * @return MenuNodeBase $this
      */
-    public function removeChild(MenuNode $child)
+    public function removeChild(NodeInterface $child)
     {
         $this->children->removeElement($child);
+
+        return $this;
     }
 
     /**

composer.json

@@ -38,7 +38,7 @@
     "target-dir": "Symfony/Cmf/Bundle/MenuBundle",
     "extra": {
         "branch-alias": {
-            "dev-master": "1.1-dev"
+            "dev-master": "1.2-dev"
         }
     }
 }