Merge pull request #219 from EmmanuelVella/child-interface

Use child interface

Author: dbu

CHANGELOG.md

@@ -1,6 +1,10 @@
 Changelog
 =========
 
+* **2014-03-25**: setParent() and getParent() are now deprecated.
+  Use setParentDocument() and getParentDocument() instead.
+  Moreover, you should now enable the ChildExtension from the CoreBundle.
+
 * **2014-03-23**: When using PHPCR-ODM, routes can now be generated with their
   uuid as route name as well, in addition to the repository path.
 

Doctrine/Phpcr/RedirectRoute.php

@@ -12,6 +12,7 @@
 
 namespace Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr;
 
+use Symfony\Cmf\Bundle\CoreBundle\Model\ChildInterface;
 use Symfony\Cmf\Bundle\RoutingBundle\Model\RedirectRoute as RedirectRouteModel;
 use Symfony\Cmf\Component\Routing\RouteObjectInterface;
 
@@ -21,7 +22,7 @@
  * This extends the RedirectRoute Model. We need to re-implement everything
  * that the PHPCR Route document adds.
  */
-class RedirectRoute extends RedirectRouteModel implements PrefixInterface
+class RedirectRoute extends RedirectRouteModel implements PrefixInterface, ChildInterface
 {
     /**
      * parent document
@@ -75,21 +76,39 @@ public function __construct($addFormatPattern = false, $addTrailingSlash = false
         $this->addTrailingSlash = $addTrailingSlash;
     }
 
+    /**
+     * @deprecated Use setParentDocument instead.
+     */
+    public function setParent($parent)
+    {
+        $this->parent = $parent;
+
+        return $this;
+    }
+
+    /**
+     * @deprecated Use getParentDocument instead.
+     */
+    public function getParent()
+    {
+        return $this->parent;
+    }
+
     /**
      * Move the route by setting a parent.
      *
      * Note that this will change the URL this route matches.
      *
      * @param object $parent the new parent document
      */
-    public function setParent($parent)
+    public function setParentDocument($parent)
     {
         $this->parent = $parent;
 
         return $this;
     }
 
-    public function getParent()
+    public function getParentDocument()
     {
         return $this->parent;
     }

Doctrine/Phpcr/Route.php

@@ -15,6 +15,7 @@
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ODM\PHPCR\Document\Generic;
 use Doctrine\ODM\PHPCR\Exception\InvalidArgumentException;
+use Symfony\Cmf\Bundle\CoreBundle\Model\ChildInterface;
 use Symfony\Cmf\Component\Routing\RouteObjectInterface;
 use Symfony\Cmf\Bundle\RoutingBundle\Model\Route as RouteModel;
 
@@ -24,7 +25,7 @@
  *
  * @author [email protected]
  */
-class Route extends RouteModel implements PrefixInterface
+class Route extends RouteModel implements PrefixInterface, ChildInterface
 {
     /**
      * parent document
@@ -88,14 +89,32 @@ public function setAddTrailingSlash($addTrailingSlash)
         $this->addTrailingSlash = $addTrailingSlash;
     }
 
+    /**
+     * @deprecated Use setParentDocument instead.
+     */
+    public function setParent($parent)
+    {
+        $this->parent = $parent;
+
+        return $this;
+    }
+
+    /**
+     * @deprecated Use getParentDocument instead.
+     */
+    public function getParent()
+    {
+        return $this->parent;
+    }
+
     /**
      * Move the route by setting a parent.
      *
      * Note that this will change the URL this route matches.
      *
      * @param object $parent the new parent document
      */
-    public function setParent($parent)
+    public function setParentDocument($parent)
     {
         if (!is_object($parent)) {
             throw new InvalidArgumentException("Parent must be an object ".gettype ($parent)." given.");
@@ -112,7 +131,7 @@ public function setParent($parent)
      *
      * @return Generic object
      */
-    public function getParent()
+    public function getParentDocument()
     {
         return $this->parent;
     }

Tests/Resources/DataFixtures/Phpcr/LoadRouteData.php

@@ -37,12 +37,12 @@ public function load(ObjectManager $manager)
         $manager->persist($parent);
 
         $route = new Route;
-        $route->setParent($parent);
+        $route->setParentDocument($parent);
         $route->setName('route-1');
         $manager->persist($route);
 
         $redirectRoute = new RedirectRoute;
-        $redirectRoute->setParent($parent);
+        $redirectRoute->setParentDocument($parent);
         $redirectRoute->setName('redirect-route-1');
         $manager->persist($redirectRoute);