Merge pull request #805 from phpDocumentor/bugfix/level-off

jaapio · web-flow · commit d545130345b7 · 2024-01-19T08:51:41.000+01:00
[BUGFIX] Correct Menu levels in global menu tree
diff --git a/packages/guides-theme-bootstrap/resources/template/body/menu/mainmenu/menu.html.twig b/packages/guides-theme-bootstrap/resources/template/body/menu/mainmenu/menu.html.twig
@@ -2,7 +2,7 @@
         {% if node.caption %}
             <h2>{{ renderNode(node.caption) }}</h2>
         {% endif %}
-        <ul class="level-1">
+        <ul class="menu-level-main">
     {% for entry in node.menuEntries -%}
         <li><a href="{{ renderLink(entry.url) }}"
            class="nav-link {%- if node.currentPath == entry.url %} current {%- endif -%}{% if entry.url in node.rootlinePaths %} active {%- endif -%}"
diff --git a/packages/guides/src/Compiler/Passes/GlobalMenuPass.php b/packages/guides/src/Compiler/Passes/GlobalMenuPass.php
@@ -97,11 +97,11 @@ private function getMenuEntryWithChildren(CompilerContext $compilerContext, Menu
             return $menuEntry;
         }
 
-        $newMenuEntry = new InternalMenuEntryNode($menuEntry->getUrl(), $menuEntry->getValue(), [], false, 2);
+        $newMenuEntry = new InternalMenuEntryNode($menuEntry->getUrl(), $menuEntry->getValue(), [], false, 1);
         $maxdepth = $this->settingsManager->getProjectSettings()->getMaxMenuDepth();
         $maxdepth = $maxdepth < 1 ? PHP_INT_MAX : $maxdepth + 1;
         $documentEntryOfMenuEntry = $compilerContext->getProjectNode()->getDocumentEntry($menuEntry->getUrl());
-        $this->addSubEntries($compilerContext, $newMenuEntry, $documentEntryOfMenuEntry, 3, $maxdepth);
+        $this->addSubEntries($compilerContext, $newMenuEntry, $documentEntryOfMenuEntry, 2, $maxdepth);
 
         return $newMenuEntry;
     }
@@ -113,7 +113,7 @@ private function addSubEntries(
         int $currentLevel,
         int $maxDepth,
     ): void {
-        if ($maxDepth < $currentLevel) {
+        if ($maxDepth <= $currentLevel) {
             return;
         }
 
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/anotherPage.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/anotherPage.html
@@ -66,7 +66,7 @@
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
                     <h2>Main Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="#"
            class="nav-link current active" aria-current="page" >
             Another Page
@@ -79,7 +79,7 @@ <h2>Main Menu</h2>
            class="nav-link">
             Subpages
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="subpages/subpage1.html"
                        class="nav-link">
                                 Subpages 1
@@ -95,7 +95,7 @@ <h2>Main Menu</h2>
 </nav>
     <nav class="nav flex-column">
                     <h2>Additional Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="yetAnotherPage.html"
            class="nav-link">
             Yet Another Page
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/index.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/index.html
@@ -66,7 +66,7 @@
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
                     <h2>Main Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="anotherPage.html"
            class="nav-link">
             Another Page
@@ -79,7 +79,7 @@ <h2>Main Menu</h2>
            class="nav-link">
             Subpages
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="subpages/subpage1.html"
                        class="nav-link">
                                 Subpages 1
@@ -95,7 +95,7 @@ <h2>Main Menu</h2>
 </nav>
     <nav class="nav flex-column">
                     <h2>Additional Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="yetAnotherPage.html"
            class="nav-link">
             Yet Another Page
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/somePage.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/somePage.html
@@ -66,7 +66,7 @@
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
                     <h2>Main Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="anotherPage.html"
            class="nav-link">
             Another Page
@@ -79,7 +79,7 @@ <h2>Main Menu</h2>
            class="nav-link">
             Subpages
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="subpages/subpage1.html"
                        class="nav-link">
                                 Subpages 1
@@ -95,7 +95,7 @@ <h2>Main Menu</h2>
 </nav>
     <nav class="nav flex-column">
                     <h2>Additional Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="yetAnotherPage.html"
            class="nav-link">
             Yet Another Page
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/subpages/index.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/subpages/index.html
@@ -66,7 +66,7 @@
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
                     <h2>Main Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="../anotherPage.html"
            class="nav-link">
             Another Page
@@ -79,7 +79,7 @@ <h2>Main Menu</h2>
            class="nav-link current active" aria-current="page" >
             Subpages
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="subpage1.html"
                        class="nav-link">
                                 Subpages 1
@@ -95,7 +95,7 @@ <h2>Main Menu</h2>
 </nav>
     <nav class="nav flex-column">
                     <h2>Additional Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="../yetAnotherPage.html"
            class="nav-link">
             Yet Another Page
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/subpages/subpage1.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/subpages/subpage1.html
@@ -66,7 +66,7 @@
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
                     <h2>Main Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="../anotherPage.html"
            class="nav-link">
             Another Page
@@ -79,7 +79,7 @@ <h2>Main Menu</h2>
            class="nav-link active">
             Subpages
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="#"
                        class="nav-link current active" aria-current="page">
                                 Subpages 1
@@ -95,7 +95,7 @@ <h2>Main Menu</h2>
 </nav>
     <nav class="nav flex-column">
                     <h2>Additional Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="../yetAnotherPage.html"
            class="nav-link">
             Yet Another Page
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/subpages/subpage2.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/subpages/subpage2.html
@@ -66,7 +66,7 @@
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
                     <h2>Main Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="../anotherPage.html"
            class="nav-link">
             Another Page
@@ -79,7 +79,7 @@ <h2>Main Menu</h2>
            class="nav-link active">
             Subpages
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="subpage1.html"
                        class="nav-link">
                                 Subpages 1
@@ -95,7 +95,7 @@ <h2>Main Menu</h2>
 </nav>
     <nav class="nav flex-column">
                     <h2>Additional Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="../yetAnotherPage.html"
            class="nav-link">
             Yet Another Page
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/yetAnotherPage.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-menu-several/expected/yetAnotherPage.html
@@ -66,7 +66,7 @@
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
                     <h2>Main Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="anotherPage.html"
            class="nav-link">
             Another Page
@@ -79,7 +79,7 @@ <h2>Main Menu</h2>
            class="nav-link">
             Subpages
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="subpages/subpage1.html"
                        class="nav-link">
                                 Subpages 1
@@ -95,7 +95,7 @@ <h2>Main Menu</h2>
 </nav>
     <nav class="nav flex-column">
                     <h2>Additional Menu</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="#"
            class="nav-link current active" aria-current="page" >
             Yet Another Page
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-menu/expected/anotherPage.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-menu/expected/anotherPage.html
@@ -47,7 +47,7 @@
             <div class="row">
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="/anotherPage.html"
            class="nav-link current active" aria-current="page" >
             Another Page
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-menu/expected/index.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-menu/expected/index.html
@@ -47,7 +47,7 @@
             <div class="row">
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="/anotherPage.html"
            class="nav-link">
             Another Page
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-menu/expected/somePage.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-menu/expected/somePage.html
@@ -47,7 +47,7 @@
             <div class="row">
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="/anotherPage.html"
            class="nav-link">
             Another Page
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-subpages-max-1/expected/index.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-subpages-max-1/expected/index.html
@@ -39,7 +39,7 @@
             <div class="row">
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="someDirectory/index.html"
            class="nav-link">
             Some Page
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-subpages-max-2/expected/index.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-subpages-max-2/expected/index.html
@@ -44,12 +44,12 @@
             <div class="row">
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="someDirectory/index.html"
            class="nav-link">
             Some Page
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="someDirectory/anotherDirectory/index.html"
                        class="nav-link">
                                 Another Page
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-subpages-max-3/expected/index.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-subpages-max-3/expected/index.html
@@ -44,17 +44,17 @@
             <div class="row">
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="someDirectory/index.html"
            class="nav-link">
             Some Page
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="someDirectory/anotherDirectory/index.html"
                        class="nav-link">
                                 Another Page
                         </a>                                
-<ul class="level-3">
+<ul class="level-2">
         <li><a href="someDirectory/anotherDirectory/yetAnotherDirectory/index.html"
                        class="nav-link">
                                 Yet Another Page
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-subpages/expected/index.html b/tests/Integration/tests-full/bootstrap/bootstrap-default-subpages/expected/index.html
@@ -44,22 +44,22 @@
             <div class="row">
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="someDirectory/index.html"
            class="nav-link">
             Some Page
                 </a>            
-<ul class="level-2">
+<ul class="level-1">
         <li><a href="someDirectory/anotherDirectory/index.html"
                        class="nav-link">
                                 Another Page
                         </a>                                
-<ul class="level-3">
+<ul class="level-2">
         <li><a href="someDirectory/anotherDirectory/yetAnotherDirectory/index.html"
                        class="nav-link">
                                 Yet Another Page
                         </a>                                
-<ul class="level-4">
+<ul class="level-3">
         <li><a href="someDirectory/anotherDirectory/yetAnotherDirectory/andYetAnotherDirectory/index.html"
                        class="nav-link">
                                 And Yet Another Page
@@ -93,7 +93,16 @@ <h1>Document Title</h1>
             <p>Lorem Ipsum Dolor.</p>
             <div class="toc">
     <ul class="menu-level">
-    <li class="toc-item"><a href="someDirectory/index.html#some-page">Some Page</a></li>
+    <li class="toc-item"><a href="someDirectory/index.html#some-page">Some Page</a>        <ul class="menu-level-1">
+            <li class="toc-item"><a href="someDirectory/anotherDirectory/index.html#another-page">Another Page</a>        <ul class="menu-level-2">
+            <li class="toc-item"><a href="someDirectory/anotherDirectory/yetAnotherDirectory/index.html#yet-another-page">Yet Another Page</a>        <ul class="menu-level-3">
+            <li class="toc-item"><a href="someDirectory/anotherDirectory/yetAnotherDirectory/andYetAnotherDirectory/index.html#and-yet-another-page">And Yet Another Page</a></li>
+
+                    </ul></li>
+
+                    </ul></li>
+
+                    </ul></li>
 
     </ul>
 </div>
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-default-subpages/input/index.rst b/tests/Integration/tests-full/bootstrap/bootstrap-default-subpages/input/index.rst
@@ -14,6 +14,5 @@ Lorem Ipsum Dolor.
 ..  toctree::
     :glob:
     :titlesonly:
-    :maxdepth: 1
 
     */index
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-index/expected/anotherPage.html b/tests/Integration/tests-full/bootstrap/bootstrap-index/expected/anotherPage.html
@@ -48,7 +48,7 @@
                             <div class="rubric">Main Menu</div>
 
     <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="/anotherPage.html"
            class="nav-link">
             Another Page
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-index/expected/index.html b/tests/Integration/tests-full/bootstrap/bootstrap-index/expected/index.html
@@ -48,7 +48,7 @@
                             <div class="rubric">Main Menu</div>
 
     <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="/anotherPage.html"
            class="nav-link">
             Another Page
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-index/expected/somePage.html b/tests/Integration/tests-full/bootstrap/bootstrap-index/expected/somePage.html
@@ -48,7 +48,7 @@
                             <div class="rubric">Main Menu</div>
 
     <nav class="nav flex-column">
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="/anotherPage.html"
            class="nav-link">
             Another Page
diff --git a/tests/Integration/tests-full/bootstrap/bootstrap-menu-external-linktargets/expected/index.html b/tests/Integration/tests-full/bootstrap/bootstrap-menu-external-linktargets/expected/index.html
@@ -48,7 +48,7 @@
                 <div class="col-lg-3">
                                 <nav class="nav flex-column">
                     <h2>Some Caption</h2>
-                <ul class="level-1">
+                <ul class="menu-level-main">
     <li><a href="https://example.com/index.html#debug-settings"
            class="nav-link">
             Title

Original file line number	Diff line number	Diff line change
`@@ -97,11 +97,11 @@ private function getMenuEntryWithChildren(CompilerContext $compilerContext, Menu`
`97`	`97`	`return $menuEntry;`
`98`	`98`	`}`
`99`	`99`
`100`		`- $newMenuEntry = new InternalMenuEntryNode($menuEntry->getUrl(), $menuEntry->getValue(), [], false, 2);`
	`100`	`+ $newMenuEntry = new InternalMenuEntryNode($menuEntry->getUrl(), $menuEntry->getValue(), [], false, 1);`
`101`	`101`	`$maxdepth = $this->settingsManager->getProjectSettings()->getMaxMenuDepth();`
`102`	`102`	`$maxdepth = $maxdepth < 1 ? PHP_INT_MAX : $maxdepth + 1;`
`103`	`103`	`$documentEntryOfMenuEntry = $compilerContext->getProjectNode()->getDocumentEntry($menuEntry->getUrl());`
`104`		`- $this->addSubEntries($compilerContext, $newMenuEntry, $documentEntryOfMenuEntry, 3, $maxdepth);`
	`104`	`+ $this->addSubEntries($compilerContext, $newMenuEntry, $documentEntryOfMenuEntry, 2, $maxdepth);`
`105`	`105`
`106`	`106`	`return $newMenuEntry;`
`107`	`107`	`}`
`@@ -113,7 +113,7 @@ private function addSubEntries(`
`113`	`113`	`int $currentLevel,`
`114`	`114`	`int $maxDepth,`
`115`	`115`	`): void {`
`116`		`- if ($maxDepth < $currentLevel) {`
	`116`	`+ if ($maxDepth <= $currentLevel) {`
`117`	`117`	`return;`
`118`	`118`	`}`
`119`	`119`