Merge pull request #76 from symfony-cmf/event

optional event handling for dynamic router

Author: lsmith77

CHANGELOG.md

@@ -4,6 +4,7 @@ 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

DynamicRouter.php

@@ -13,8 +13,10 @@
 use Symfony\Component\Routing\Exception\RouteNotFoundException;
 use Symfony\Component\Routing\Exception\ResourceNotFoundException;
 use Symfony\Component\Routing\Exception\MethodNotAllowedException;
-
 use Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Cmf\Component\Routing\Event\Events;
+use Symfony\Cmf\Component\Routing\Event\RouterMatchEvent;
 
 /**
  * A flexible router accepting matcher and generator through injection and
@@ -35,6 +37,11 @@ class DynamicRouter implements RouterInterface, RequestMatcherInterface, Chained
      */
     protected $generator;
 
+    /**
+     * @var EventDispatcherInterface
+     */
+    protected $eventDispatcher;
+
     /**
      * @var RouteEnhancerInterface[]
      */
@@ -64,15 +71,21 @@ class DynamicRouter implements RouterInterface, RequestMatcherInterface, Chained
      * @param RequestMatcherInterface|UrlMatcherInterface $matcher
      * @param UrlGeneratorInterface                       $generator
      * @param string                                      $uriFilterRegexp
+     * @param EventDispatcherInterface|null               $eventDispatcher
      */
-    public function __construct(RequestContext $context, $matcher, UrlGeneratorInterface $generator, $uriFilterRegexp = '')
-    {
+    public function __construct(RequestContext $context,
+                                $matcher,
+                                UrlGeneratorInterface $generator,
+                                $uriFilterRegexp = '',
+                                EventDispatcherInterface $eventDispatcher = null
+    ) {
         $this->context = $context;
         if (! $matcher instanceof RequestMatcherInterface && ! $matcher instanceof UrlMatcherInterface) {
             throw new \InvalidArgumentException('Invalid $matcher');
         }
         $this->matcher = $matcher;
         $this->generator = $generator;
+        $this->eventDispatcher = $eventDispatcher;
         $this->uriFilterRegexp = $uriFilterRegexp;
 
         $this->generator->setContext($context);
@@ -167,6 +180,12 @@ public function supports($name)
      */
     public function match($pathinfo)
     {
+        $request = Request::create($pathinfo);
+        if ($this->eventDispatcher) {
+            $event = new RouterMatchEvent();
+            $this->eventDispatcher->dispatch(Events::PRE_DYNAMIC_MATCH, $event);
+        }
+
         if (! empty($this->uriFilterRegexp) && ! preg_match($this->uriFilterRegexp, $pathinfo)) {
             throw new ResourceNotFoundException("$pathinfo does not match the '{$this->uriFilterRegexp}' pattern");
         }
@@ -178,7 +197,7 @@ public function match($pathinfo)
 
         $defaults = $matcher->match($pathinfo);
 
-        return $this->applyRouteEnhancers($defaults, Request::create($pathinfo));
+        return $this->applyRouteEnhancers($defaults, $request);
     }
 
     /**
@@ -198,6 +217,11 @@ public function match($pathinfo)
      */
     public function matchRequest(Request $request)
     {
+        if ($this->eventDispatcher) {
+            $event = new RouterMatchEvent($request);
+            $this->eventDispatcher->dispatch(Events::PRE_DYNAMIC_MATCH_REQUEST, $event);
+        }
+
         if (! empty($this->uriFilterRegexp)
             && ! preg_match($this->uriFilterRegexp, $request->getPathInfo())
         ) {
@@ -206,12 +230,11 @@ public function matchRequest(Request $request)
 
         $matcher = $this->getMatcher();
         if ($matcher instanceof UrlMatcherInterface) {
-            // the match method will enhance the route $defaults
-            return $this->match($request->getPathInfo());
+            $defaults = $matcher->match($request->getPathInfo());
+        } else {
+            $defaults = $matcher->matchRequest($request);
         }
 
-        $defaults = $matcher->matchRequest($request);
-
         return $this->applyRouteEnhancers($defaults, $request);
     }
 

Event/Events.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Symfony\Cmf\Component\Routing\Event;
+
+final class Events
+{
+    /**
+     * Fired before a path is matched in \Symfony\Cmf\Component\Routing\DynamicRouter#match
+     *
+     * The event object is RouteMatchEvent.
+     */
+    const PRE_DYNAMIC_MATCH = 'cmf_routing.pre_dynamic_match';
+
+    /**
+     * Fired before a Request is matched in \Symfony\Cmf\Component\Routing\DynamicRouter#match
+     *
+     * The event object is RouteMatchEvent.
+     */
+    const PRE_DYNAMIC_MATCH_REQUEST = 'cmf_routing.pre_dynamic_match_request';
+}

Event/RouterMatchEvent.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Symfony\Cmf\Component\Routing\Event;
+
+use Symfony\Component\EventDispatcher\Event;
+use Symfony\Component\HttpFoundation\Request;
+
+class RouterMatchEvent extends Event
+{
+    /**
+     * @var Request
+     */
+    protected $request;
+
+    /**
+     * @param Request $request
+     */
+    public function __construct(Request $request = null)
+    {
+        $this->request = $request;
+    }
+
+    /**
+     * @return Request | null
+     */
+    public function getRequest()
+    {
+        return $this->request;
+    }
+}

Tests/Routing/DynamicRouterTest.php

@@ -2,6 +2,8 @@
 
 namespace Symfony\Cmf\Component\Routing\Tests\Routing;
 
+use Symfony\Cmf\Component\Routing\Event\Events;
+use Symfony\Cmf\Component\Routing\Event\RouterMatchEvent;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Routing\RouteCollection;
 
@@ -177,7 +179,7 @@ public function testMatchRequest()
         $expected = array('this' => 'that');
         $this->enhancer->expects($this->once())
             ->method('enhance')
-            ->with($this->equalTo($routeDefaults), $this->equalTo($this->request)) // TODO: why do we not get the right thing?
+            ->with($this->equalTo($routeDefaults), $this->equalTo($this->request))
             ->will($this->returnValue($expected))
         ;
 
@@ -262,4 +264,24 @@ public function testRouteDebugMessageNonversatile()
         $router = new DynamicRouter($this->context, $this->matcher, $generator);
         $this->assertInternalType('string', $router->getRouteDebugMessage('test'));
     }
+
+    public function testEventHandler()
+    {
+        $eventDispatcher = $this->buildMock('Symfony\Component\EventDispatcher\EventDispatcherInterface');
+        $router = new DynamicRouter($this->context, $this->matcher, $this->generator, '', $eventDispatcher);
+
+        $eventDispatcher->expects($this->once())
+            ->method('dispatch')
+            ->with(Events::PRE_DYNAMIC_MATCH, $this->equalTo(new RouterMatchEvent()))
+        ;
+
+        $routeDefaults = array('foo' => 'bar');
+        $this->matcher->expects($this->once())
+            ->method('match')
+            ->with($this->url)
+            ->will($this->returnValue($routeDefaults))
+        ;
+
+        $this->assertEquals($routeDefaults, $router->match($this->url));
+    }
 }

composer.json

@@ -20,10 +20,12 @@
     },
     "require-dev": {
         "symfony/dependency-injection": "~2.0",
-        "symfony/config": "~2.2"
+        "symfony/config": "~2.2",
+        "symfony/event-dispatcher": "~2.1"
     },
     "suggest": {
-        "symfony/http-foundation": "ChainRouter/DynamicRouter have optional support for Request instances, several enhancers require a Request instances, ~2.2"
+        "symfony/http-foundation": "ChainRouter/DynamicRouter have optional support for Request instances, several enhancers require a Request instances, ~2.2",
+        "symfony/event-dispatcher": "DynamicRouter can optionally trigger an event at the start of matching, ~2.1"
     },
     "autoload": {
         "psr-0": { "Symfony\\Cmf\\Component\\Routing": "" }