Merge pull request zendframework/zendframework#4348 from tomshaw/zf4346

Add isActive method Navigation Page Uri.

src/Page/Uri.php

@@ -9,6 +9,7 @@
 
 namespace Zend\Navigation\Page;
 
+use Zend\Http\Request;
 use Zend\Navigation\Exception;
 
 /**
@@ -22,6 +23,13 @@ class Uri extends AbstractPage
      * @var string|null
      */
     protected $uri = null;
+
+    /**
+     * Request object used to determine uri path
+     *
+     * @var string
+     */
+    protected $request;
 
     /**
      * Sets page URI
@@ -75,6 +83,53 @@ public function getHref()
 
         return $uri;
     }
+
+    /**
+     * Returns whether page should be considered active or not
+     *
+     * This method will compare the page properties against the request uri.
+     *
+     * @param bool $recursive
+     *            [optional] whether page should be considered
+     *            active if any child pages are active. Default is
+     *            false.
+     * @return bool whether page should be considered active or not
+     */
+    public function isActive($recursive = false)
+    {
+        if (!$this->active) {
+            if ($this->getRequest() instanceof Request) {
+                if ($this->getRequest()->getUri()->getPath() == $this->getUri()) {
+                    $this->active = true;
+                    return true;
+                }
+            }
+        }
+
+        return parent::isActive($recursive);
+    }
+
+    /**
+     * Get the request
+     *
+     * @return Request
+     */
+    public function getRequest()
+    {
+        return $this->request;
+    }
+
+    /**
+     * Sets request for assembling URLs
+     *
+     * @param Request $request            
+     * @return Fluent interface, returns self
+     */
+    public function setRequest(Request $request)
+    {
+        $this->request = $request;
+        return $this;
+    }
 
     /**
      * Returns an array representation of the page
@@ -90,4 +145,4 @@ public function toArray()
             )
         );
     }
-}
+}

src/Service/AbstractNavigationFactory.php

@@ -10,6 +10,7 @@
 namespace Zend\Navigation\Service;
 
 use Zend\Config;
+use Zend\Http\Request;
 use Zend\Mvc\Router\RouteMatch;
 use Zend\Mvc\Router\RouteStackInterface as Router;
 use Zend\Navigation\Exception;
@@ -79,8 +80,9 @@ protected function preparePages(ServiceLocatorInterface $serviceLocator, $pages)
         $application = $serviceLocator->get('Application');
         $routeMatch  = $application->getMvcEvent()->getRouteMatch();
         $router      = $application->getMvcEvent()->getRouter();
+        $request     = $application->getMvcEvent()->getRequest();
 
-        return $this->injectComponents($pages, $routeMatch, $router);
+        return $this->injectComponents($pages, $routeMatch, $router, $request);
     }
 
     /**
@@ -114,11 +116,13 @@ protected function getPagesFromConfig($config = null)
      * @param array $pages
      * @param RouteMatch $routeMatch
      * @param Router $router
+     * @param Request $request
      * @return mixed
      */
-    protected function injectComponents(array $pages, RouteMatch $routeMatch = null, Router $router = null)
+    protected function injectComponents(array $pages, RouteMatch $routeMatch = null, Router $router = null, Request $request = null)
     {
         foreach ($pages as &$page) {
+            $hasUri = isset($page['uri']);
             $hasMvc = isset($page['action']) || isset($page['controller']) || isset($page['route']);
             if ($hasMvc) {
                 if (!isset($page['routeMatch']) && $routeMatch) {
@@ -127,12 +131,17 @@ protected function injectComponents(array $pages, RouteMatch $routeMatch = null,
                 if (!isset($page['router'])) {
                     $page['router'] = $router;
                 }
+            } elseif ($hasUri) {
+                if (!isset($page['request'])) {
+                    $page['request'] = $request;
+                }   
             }
 
             if (isset($page['pages'])) {
-                $page['pages'] = $this->injectComponents($page['pages'], $routeMatch, $router);
+                $page['pages'] = $this->injectComponents($page['pages'], $routeMatch, $router, $request);
             }
         }
         return $pages;
     }
+
 }

test/Page/UriTest.php

@@ -12,6 +12,7 @@
 
 use Zend\Navigation\Page;
 use Zend\Navigation;
+use Zend\Http\Request;
 
 /**
  * Tests the class Zend_Navigation_Page_Uri
@@ -22,7 +23,7 @@
  * @group      Zend_Navigation
  */
 class UriTest extends \PHPUnit_Framework_TestCase
-{
+{	
     public function testUriOptionAsString()
     {
         $page = new Page\Uri(array(
@@ -89,6 +90,40 @@ public function testGetHref()
 
         $this->assertEquals($uri, $page->getHref());
     }
+
+    public function testIsActiveReturnsTrueWhenHasMatchingRequestUri()
+    {
+        $page = new Page\Uri(array(
+            'label' => 'foo',
+            'uri' => '/bar'
+        ));
+
+        $request = new Request();
+        $request->setUri('/bar');
+        $request->setMethod('GET');
+
+        $page->setRequest($request);
+
+        $this->assertInstanceOf('Zend\Http\Request', $page->getRequest());
+
+        $this->assertTrue($page->isActive());
+    }
+
+    public function testIsActiveReturnsFalseOnNonMatchingRequestUri()
+    {
+        $page = new Page\Uri(array(
+            'label' => 'foo',
+            'uri' => '/bar'
+        ));
+
+        $request = new Request();
+        $request->setUri('/baz');
+        $request->setMethod('GET');
+
+        $page->setRequest($request);
+
+        $this->assertFalse($page->isActive());
+    }
 
     /**
      * @group ZF-8922