Merge branch 'feature/5803' into develop

Close #5803
Fixes #2925

README.md

@@ -34,6 +34,10 @@ version of PHP available to ensure you have the latest security fixes.
 
 Additional updates that may affect existing applications include:
 
+- [#5803](https://github.com/zendframework/zf2/pull/5803) adds a new flag to
+  `Zend\Navigation` containers' `hasPages()` method, `$onlyVisible`. If set to
+  `true`, only pages that are visibile based on ACLs will be considered.
+
 - [#5759](https://github.com/zendframework/zf2/pull/5759) adds a new method to
   the `FlashMessenger` view helper, `renderCurrent()`, which will render
   messages registered with the `FlashMessenger` during the current request (vs.

library/Zend/Navigation/AbstractContainer.php

@@ -258,10 +258,20 @@ public function hasPage(Page\AbstractPage $page, $recursive = false)
     /**
      * Returns true if container contains any pages
      *
+     * @param  bool $onlyVisible whether to check only visible pages
      * @return bool  whether container has any pages
      */
-    public function hasPages()
+    public function hasPages($onlyVisible = false)
     {
+        if ($onlyVisible) {
+            foreach ($this->pages as $page) {
+                if ($page->isVisible()) {
+                    return true;
+                }
+            }
+            // no visible pages found
+            return false;
+        }
         return count($this->index) > 0;
     }
 

library/Zend/View/Helper/Navigation/Menu.php

@@ -141,10 +141,10 @@ protected function renderDeepestMenu(
 
         // special case if active page is one below minDepth
         if ($active['depth'] < $minDepth) {
-            if (!$active['page']->hasPages()) {
+            if (!$active['page']->hasPages(!$this->renderInvisible)) {
                 return '';
             }
-        } elseif (!$active['page']->hasPages()) {
+        } elseif (!$active['page']->hasPages(!$this->renderInvisible)) {
             // found pages has no children; render siblings
             $active['page'] = $active['page']->getParent();
         } elseif (is_int($maxDepth) && $active['depth'] +1 > $maxDepth) {
@@ -293,7 +293,7 @@ protected function renderNormalMenu(
                         $accept = true;
                     } elseif ($foundPage->getParent()->hasPage($page)) {
                         // page is a sibling of the active page...
-                        if (!$foundPage->hasPages() ||
+                        if (!$foundPage->hasPages(!$this->renderInvisible) ||
                             is_int($maxDepth) && $foundDepth + 1 > $maxDepth) {
                             // accept if active page has no children, or the
                             // children are too deep to be rendered

tests/ZendTest/Navigation/ContainerTest.php

@@ -682,19 +682,35 @@ public function testHasPages()
     {
         $nav1 = new Navigation\Navigation();
         $nav2 = new Navigation\Navigation();
+        $nav3 = new Navigation\Navigation();
+        $nav4 = new Navigation\Navigation();
         $nav2->addPage(array(
             'label' => 'Page 1',
             'uri' => '#'
         ));
+        $nav3->addPage(array(
+            'label' => 'Page 1',
+            'uri' => '#',
+            'visible' => true
+        ));
+        $nav4->addPage(array(
+            'label' => 'Page 1',
+            'uri' => '#',
+            'visible' => false
+        ));
 
         $expected = array(
             'empty' => false,
-            'notempty' => true
+            'notempty' => true,
+            'visible' => true,
+            'notvisible' => false
         );
 
         $actual = array(
             'empty' => $nav1->hasPages(),
-            'notempty' => $nav2->hasPages()
+            'notempty' => $nav2->hasPages(),
+            'visible' => $nav3->hasPages(false),
+            'notvisible' => $nav4->hasPages(true)
         );
 
         $this->assertEquals($expected, $actual);