Merge branch 'hotfix/router-abstraction'

Close #58

Author: weierophinney

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
-## 2.6.7 - TBD
+## 2.6.7 - 2016-04-18
 
 ### Added
 
@@ -18,7 +18,9 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Fixed
 
-- Nothing.
+- [#58](https://github.com/zendframework/zend-view/pull/58) updates the `url()`
+  helper so that it can work with either the zend-mvc v2 router subcomponent or
+  zend-router.
 
 ## 2.6.6 - 2016-04-18
 

composer.json

@@ -35,6 +35,7 @@
         "zendframework/zend-navigation": "^2.5",
         "zendframework/zend-paginator": "^2.5",
         "zendframework/zend-permissions-acl": "^2.6",
+        "zendframework/zend-router": "^3.0.1",
         "zendframework/zend-serializer": "^2.6.1",
         "zendframework/zend-session": "^2.6.2",
         "zendframework/zend-servicemanager": "^2.7.5 || ^3.0.3",

composer.lock

@@ -11,8 +11,10 @@
 
 use Traversable;
 use Zend\Mvc\ModuleRouteListener;
-use Zend\Mvc\Router\RouteMatch;
-use Zend\Mvc\Router\RouteStackInterface;
+use Zend\Mvc\Router\RouteMatch as LegacyRouteMatch;
+use Zend\Mvc\Router\RouteStackInterface as LegacyRouteStackInterface;
+use Zend\Router\RouteMatch;
+use Zend\Router\RouteStackInterface;
 use Zend\View\Exception;
 
 /**
@@ -21,32 +23,36 @@
 class Url extends AbstractHelper
 {
     /**
-     * RouteStackInterface instance.
+     * Router instance.
      *
-     * @var RouteStackInterface
+     * @var LegacyRouteStackInterface|RouteStackInterface
      */
     protected $router;
 
     /**
-     * RouteInterface match returned by the router.
+     * Route matches returned by the router.
      *
-     * @var RouteMatch.
+     * @var LegacyRouteMatch|RouteMatch.
      */
     protected $routeMatch;
 
     /**
      * Generates a url given the name of a route.
      *
-     * @see    Zend\Mvc\Router\RouteInterface::assemble()
-     * @param  string               $name               Name of the route
-     * @param  array                $params             Parameters for the link
-     * @param  array|Traversable    $options            Options for the route
-     * @param  bool                 $reuseMatchedParams Whether to reuse matched parameters
-     * @return string Url                         For the link href attribute
-     * @throws Exception\RuntimeException         If no RouteStackInterface was provided
-     * @throws Exception\RuntimeException         If no RouteMatch was provided
-     * @throws Exception\RuntimeException         If RouteMatch didn't contain a matched route name
-     * @throws Exception\InvalidArgumentException If the params object was not an array or \Traversable object
+     * @see Zend\Mvc\Router\RouteInterface::assemble()
+     * @see Zend\Router\RouteInterface::assemble()
+     * @param  string $name Name of the route
+     * @param  array $params Parameters for the link
+     * @param  array|Traversable $options Options for the route
+     * @param  bool $reuseMatchedParams Whether to reuse matched parameters
+     * @return string Url For the link href attribute
+     * @throws Exception\RuntimeException If no RouteStackInterface was
+     *     provided
+     * @throws Exception\RuntimeException If no RouteMatch was provided
+     * @throws Exception\RuntimeException If RouteMatch didn't contain a
+     *     matched route name
+     * @throws Exception\InvalidArgumentException If the params object was not
+     *     an array or Traversable object.
      */
     public function __invoke($name = null, $params = [], $options = [], $reuseMatchedParams = false)
     {
@@ -103,23 +109,48 @@ public function __invoke($name = null, $params = [], $options = [], $reuseMatche
     /**
      * Set the router to use for assembling.
      *
-     * @param RouteStackInterface $router
+     * @param LegacyRouteStackInterface|RouteStackInterface $router
      * @return Url
+     * @throws Exception\InvalidArgumentException for invalid router types.
      */
-    public function setRouter(RouteStackInterface $router)
+    public function setRouter($router)
     {
+        if (! $router instanceof RouteStackInterface
+            && ! $router instanceof LegacyRouteStackInterface
+        ) {
+            throw new Exception\InvalidArgumentException(sprintf(
+                '%s expects a %s or %s instance; received %s',
+                __METHOD__,
+                RouteStackInterface::class,
+                LegacyRouteStackInterface::class,
+                (is_object($router) ? get_class($router) : gettype($router))
+            ));
+        }
+
         $this->router = $router;
         return $this;
     }
 
     /**
      * Set route match returned by the router.
      *
-     * @param  RouteMatch $routeMatch
+     * @param  LegacyRouteMatch|RouteMatch $routeMatch
      * @return Url
      */
-    public function setRouteMatch(RouteMatch $routeMatch)
+    public function setRouteMatch($routeMatch)
     {
+        if (! $routeMatch instanceof RouteMatch
+            && ! $routeMatch instanceof LegacyRouteMatch
+        ) {
+            throw new Exception\InvalidArgumentException(sprintf(
+                '%s expects a %s or %s instance; received %s',
+                __METHOD__,
+                RouteMatch::class,
+                LegacyRouteMatch::class,
+                (is_object($routeMatch) ? get_class($routeMatch) : gettype($routeMatch))
+            ));
+        }
+
         $this->routeMatch = $routeMatch;
         return $this;
     }

src/Helper/Url.php

@@ -14,6 +14,8 @@
 use Zend\Mvc\ModuleRouteListener;
 use Zend\Mvc\Router\RouteMatch;
 use Zend\Mvc\Router\SimpleRouteStack as Router;
+use Zend\Router\RouteMatch as NextGenRouteMatch;
+use Zend\Router\SimpleRouteStack as NextGenRouter;
 
 /**
  * Zend\View\Helper\Url Test
@@ -201,4 +203,20 @@ public function testRemovesModuleRouteListenerParamsWhenReusingMatchedParameters
         $url = $helper->__invoke('default/wildcard', ['Twenty' => 'Cooler'], true);
         $this->assertEquals('/Rainbow/Dash=Twenty%Cooler', $url);
     }
+
+    public function testAcceptsNextGenRouterToSetRouter()
+    {
+        $router = new NextGenRouter();
+        $url = new UrlHelper();
+        $url->setRouter($router);
+        $this->assertAttributeSame($router, 'router', $url);
+    }
+
+    public function testAcceptsNextGenRouteMatche()
+    {
+        $routeMatch = new NextGenRouteMatch([]);
+        $url = new UrlHelper();
+        $url->setRouteMatch($routeMatch);
+        $this->assertAttributeSame($routeMatch, 'routeMatch', $url);
+    }
 }