last round of cleaning up interface names

Author: dbu

CHANGELOG.md

@@ -4,8 +4,13 @@ Changelog
 1.1
 ---
 
-* **2013-07-31**: DynamicRouter now accepts an EventDispatcher to trigger a RouteMatchEvent right before the matching starts
-* **2013-07-29**: Renamed RouteAwareInterface to RouteReferrersInterface for naming consistency
-* **2013-07-13**: NestedMatcher now expects a FinalMatcherInterface as second argument of the constructor
-* **2013-04-30**: Dropped Symfony 2.1 support and got rid of ConfigurableUrlMatcher class
-* **2013-04-05**: [ContentAwareGenerator] Fix locale handling to always respect locale but never have unnecessary ?locale=
+* **2013-07-31**: DynamicRouter now accepts an EventDispatcher to trigger a
+  RouteMatchEvent right before the matching starts
+* **2013-07-29**: Renamed RouteAwareInterface to RouteReferrersReadInterface
+  for naming consistency and added RouteReferrersInterface for write access.
+* **2013-07-13**: NestedMatcher now expects a FinalMatcherInterface as second
+  argument of the constructor
+* **2013-04-30**: Dropped Symfony 2.1 support and got rid of
+  ConfigurableUrlMatcher class
+* **2013-04-05**: [ContentAwareGenerator] Fix locale handling to always respect
+  locale but never have unnecessary ?locale=

ContentAwareGenerator.php

@@ -42,7 +42,7 @@ public function setContentRepository(ContentRepositoryInterface $contentReposito
      * @param string $name       ignored
      * @param array  $parameters must either contain the field 'route' with a
      *      RouteObjectInterface or the field 'content_id' with a document
-     *      id to get the route for (implementing RouteReferrersInterface)
+     *      id to get the route for (implementing RouteReferrersReadInterface)
      *
      * @throws RouteNotFoundException If there is no such route in the database
      */
@@ -104,7 +104,7 @@ protected function getBestLocaleRoute(SymfonyRoute $route, $parameters)
         $locale = $this->getLocale($parameters);
         if (! $this->checkLocaleRequirement($route, $locale)) {
             $content = $route->getContent();
-            if ($content instanceof RouteReferrersInterface) {
+            if ($content instanceof RouteReferrersReadInterface) {
                 $routes = $content->getRoutes();
                 $contentRoute = $this->getRouteByLocale($routes, $locale);
                 if ($contentRoute) {
@@ -117,9 +117,10 @@ protected function getBestLocaleRoute(SymfonyRoute $route, $parameters)
     }
 
     /**
-     * Get the route based on the $name that is a RouteReferrersInterface or a
-     * RouteReferrersInterface content found in the content repository with the
-     * content_id specified in parameters.
+     * Get the route based on the $name that is an object implementing
+     * RouteReferrersReadInterface or a content found in the content repository
+     * with the content_id specified in parameters that is an instance of
+     * RouteReferrersReadInterface.
      *
      * Called in generate when there is no route given in the parameters.
      *
@@ -132,15 +133,15 @@ protected function getBestLocaleRoute(SymfonyRoute $route, $parameters)
      *
      * @param mixed $name
      * @param array $parameters which should contain a content field containing
-     *      a RouteReferrersInterface object
+     *      a RouteReferrersReadInterface object
      *
      * @return SymfonyRoute the route instance
      *
      * @throws RouteNotFoundException if no route can be determined
      */
     protected function getRouteByContent($name, &$parameters)
     {
-        if ($name instanceof RouteReferrersInterface) {
+        if ($name instanceof RouteReferrersReadInterface) {
             $content = $name;
         } elseif (isset($parameters['content_id'])
             && null !== $this->contentRepository
@@ -149,12 +150,12 @@ protected function getRouteByContent($name, &$parameters)
             if (empty($content)) {
                 throw new RouteNotFoundException('The content repository found nothing at id ' . $parameters['content_id']);
             }
-            if (!$content instanceof RouteReferrersInterface) {
-                throw new RouteNotFoundException('Content repository did not return a RouteReferrersInterface for id ' . $parameters['content_id']);
+            if (!$content instanceof RouteReferrersReadInterface) {
+                throw new RouteNotFoundException('Content repository did not return a RouteReferrersReadInterface instance for id ' . $parameters['content_id']);
             }
         } else {
             $hint = is_object($name) ? get_class($name) : gettype($name);
-            throw new RouteNotFoundException("The route name argument '$hint' is not RouteReferrersInterface and there is no 'content_id' parameter");
+            throw new RouteNotFoundException("The route name argument '$hint' is not RouteReferrersReadInterface instance and there is no 'content_id' parameter");
         }
 
         $routes = $content->getRoutes();
@@ -234,7 +235,7 @@ protected function getLocale($parameters)
      */
     public function supports($name)
     {
-        return ! $name || parent::supports($name) || $name instanceof RouteReferrersInterface;
+        return ! $name || parent::supports($name) || $name instanceof RouteReferrersReadInterface;
     }
 
     /**
@@ -246,7 +247,7 @@ public function getRouteDebugMessage($name, array $parameters = array())
             return 'Content id ' . $parameters['content_id'];
         }
 
-        if ($name instanceof RouteReferrersInterface) {
+        if ($name instanceof RouteReferrersReadInterface) {
             return 'Route aware content ' . $name;
         }
 

ContentRepositoryInterface.php

@@ -16,8 +16,8 @@ interface ContentRepositoryInterface
     /**
      * Return a content object by it's id or null if there is none.
      *
-     * If the returned content implements RouteReferrersInterface, it will be used
-     * to get the route from it to generate an URL.
+     * If the returned content implements RouteReferrersReadInterface, it will
+     * be used to get the route from it to generate an URL.
      *
      * @param string $id id of the content object
      *

RouteReferrersInterface.php

@@ -2,20 +2,25 @@
 
 namespace Symfony\Cmf\Component\Routing;
 
+use Symfony\Component\Routing\Route;
+
 /**
- * Interface to be implemented by content that wants to be compatible with the
- * DynamicRouter
+ * Interface to be implemented by content that exposes editable route
+ * referrers.
  */
-interface RouteReferrersInterface
+interface RouteReferrersInterface extends RouteReferrersReadInterface
 {
     /**
-     * Get the routes that point to this content.
+     * Add a route to the collection.
      *
-     * Note: For PHPCR ODM, as explained in RouteObjectInterface the route must use the
-     * routeContent field to store the reference to the content so you can get the routes with
-     * Referrers(referringDocument="Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\Route", referencedBy="routeContent")
+     * @param Route $route
+     */
+    public function addRoute($route);
+
+    /**
+     * Remove a route from the collection.
      *
-     * @return \Symfony\Component\Routing\Route[] Route instances that point to this content
+     * @param Route $route
      */
-    public function getRoutes();
+    public function removeRoute($route);
 }

RouteReferrersReadInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Symfony\Cmf\Component\Routing;
+
+use Symfony\Component\Routing\Route;
+
+/**
+ * Interface to be implemented by content that wants to be support route generation
+ * from content with the DynamicRouter by providing the routes that point to it.
+ */
+interface RouteReferrersReadInterface
+{
+    /**
+     * Get the routes that point to this content.
+     *
+     * @return Route[] Route instances that point to this content
+     */
+    public function getRoutes();
+}

Tests/Routing/ContentAwareGeneratorTest.php

@@ -2,7 +2,7 @@
 
 namespace Symfony\Cmf\Component\Routing\Tests\Routing;
 
-use Symfony\Cmf\Component\Routing\RouteReferrersInterface;
+use Symfony\Cmf\Component\Routing\RouteReferrersReadInterface;
 
 use Symfony\Cmf\Component\Routing\ContentAwareGenerator;
 use Symfony\Cmf\Component\Routing\Test\CmfUnitTestCase;
@@ -22,7 +22,7 @@ class ContentAwareGeneratorTest extends CmfUnitTestCase
 
     public function setUp()
     {
-        $this->contentDocument = $this->buildMock('Symfony\\Cmf\\Component\\Routing\\RouteReferrersInterface');
+        $this->contentDocument = $this->buildMock('Symfony\\Cmf\\Component\\Routing\\RouteReferrersReadInterface');
         $this->routeDocument = $this->buildMock('Symfony\\Cmf\\Component\\Routing\\Tests\\Routing\\RouteMock', array('getDefaults', 'compile'));
         $this->routeCompiled = $this->buildMock('Symfony\\Component\\Routing\\CompiledRoute');
         $this->provider = $this->buildMock("Symfony\\Cmf\\Component\\Routing\\RouteProviderInterface");
@@ -367,7 +367,7 @@ protected function doGenerate($variables, $defaults, $requirements, $tokens, $pa
     }
 }
 
-class RouteAware implements RouteReferrersInterface
+class RouteAware implements RouteReferrersReadInterface
 {
     public function getRoutes()
     {

VersatileGeneratorInterface.php

@@ -29,7 +29,7 @@ public function supports($name);
      *
      * @param mixed $name
      * @param array $parameters which should contain a content field containing
-     *                          a RouteReferrersInterface object
+     *                          a RouteReferrersReadInterface object
      *
      * @return string
      */