Display sections in simple toctree

Author: linawolf

packages/guides/resources/template/html/body/menu/menu-item.html.twig

@@ -1,8 +1,16 @@
 <li class="toc-item"><a href="{{ url }}">{{ renderNode(node.value.value) }}</a>
-
     {%- if node.children|length %}
-        {% include "body/menu/menu-level.html.twig" with {
-            tocItems:tocItem.children
-        } %}
+        <ul class="menu-level-{{ node.level }}">
+            {% for child in node.children -%}
+                {{ renderNode(child) }}
+            {% endfor %}
+        </ul>
+    {%- endif -%}
+    {%- if node.sections|length %}
+        <ul class="section-level-{{ node.level }}">
+            {% for subsection in node.sections -%}
+                {{ renderNode(subsection) }}
+            {% endfor %}
+        </ul>
     {%- endif -%}
 </li>

packages/guides/src/Compiler/NodeTransformers/DocumentEntryRegistrationTransformer.php

@@ -37,8 +37,9 @@ public function leaveNode(Node $node, CompilerContext $compilerContext): Node|nu
 
         $entry = new DocumentEntryNode($node->getFilePath(), $node->getTitle() ?? TitleNode::emptyNode());
         $compilerContext->getProjectNode()->addDocumentEntry($entry);
+        $node->setDocumentEntry($entry);
 
-        return $node->withDocumentEntry($entry);
+        return $node;
     }
 
     public function supports(Node $node): bool

packages/guides/src/Compiler/NodeTransformers/MenuNodeTransformer.php

@@ -12,13 +12,13 @@
 
 use function array_pop;
 use function assert;
+use function count;
 use function end;
-use function sizeof;
 
 /** @implements NodeTransformer<Node> */
 class SectionEntryRegistrationTransformer implements NodeTransformer
 {
-    /** @var SectionEntryNode $sectionStack */
+    /** @var SectionEntryNode[] $sectionStack */
     private array $sectionStack = [];
 
     public function enterNode(Node $node, CompilerContext $compilerContext): Node
@@ -28,8 +28,8 @@ public function enterNode(Node $node, CompilerContext $compilerContext): Node
         }
 
         $sectionEntryNode = new SectionEntryNode($node->getTitle());
-        if (sizeof($this->sectionStack) === 0) {
-            $compilerContext->getDocumentNode()->getDocumentEntry()->addSection($sectionEntryNode);
+        if (count($this->sectionStack) === 0) {
+            $compilerContext->getDocumentNode()->getDocumentEntry()?->addSection($sectionEntryNode);
         } else {
             $parentSection = end($this->sectionStack);
             assert($parentSection instanceof SectionEntryNode);

packages/guides/src/Compiler/NodeTransformers/SectionEntryRegistrationTransformer.php

@@ -7,12 +7,15 @@
 use phpDocumentor\Guides\Compiler\CompilerContext;
 use phpDocumentor\Guides\Compiler\NodeTransformer;
 use phpDocumentor\Guides\Nodes\DocumentTree\DocumentEntryNode;
-use phpDocumentor\Guides\Nodes\Menu\MenuEntry;
+use phpDocumentor\Guides\Nodes\DocumentTree\SectionEntryNode;
+use phpDocumentor\Guides\Nodes\Menu\MenuEntryNode;
 use phpDocumentor\Guides\Nodes\Menu\MenuNode;
 use phpDocumentor\Guides\Nodes\Menu\TocNode;
 use phpDocumentor\Guides\Nodes\Node;
 
 use function array_pop;
+use function assert;
+use function count;
 use function explode;
 use function implode;
 use function preg_match;
@@ -43,23 +46,34 @@ public function leaveNode(Node $node, CompilerContext $compilerContext): Node|nu
 
         foreach ($files as $file) {
             foreach ($documentEntries as $documentEntry) {
-                if ($this->isEqualAbsolutePath($documentEntry, $file, $currentPath, $glob)) {
-                    $documentEntriesInTree[] = $documentEntry;
-                    $menuEntry = new MenuEntry($documentEntry->getFile(), $documentEntry->getTitle(), [], false);
-                    $menuEntries[] = $menuEntry;
-                    if (!$glob) {
-                        // If blob is not set, there may only be one result per listed file
-                        break;
-                    }
-                } elseif ($this->isEqualRelativePath($documentEntry, $file, $currentPath, $glob)) {
-                    $documentEntriesInTree[] = $documentEntry;
-                    $menuEntry = new MenuEntry($documentEntry->getFile(), $documentEntry->getTitle(), [], false, 1);
-                    $menuEntries[] = $menuEntry;
-                    if (!$glob) {
-                        // If blob is not set, there may only be one result per listed file
-                        break;
+                if (!$this->isEqualAbsolutePath($documentEntry, $file, $currentPath, $glob) && !$this->isEqualRelativePath($documentEntry, $file, $currentPath, $glob)) {
+                    continue;
+                }
+
+                $documentEntriesInTree[] = $documentEntry;
+                $menuEntry = new MenuEntryNode($documentEntry->getFile(), $documentEntry->getTitle(), [], false, 1);
+                if (!$node->hasOption('titlesonly') && count($documentEntry->getSections()) > 0) {
+                    foreach ($documentEntry->getSections() as $section) {
+                        // We do not add the main section as it repeats the document title
+                        if (count($section->getChildren()) <= 0) {
+                            continue;
+                        }
+
+                        foreach ($section->getChildren() as $subSectionEntryNode) {
+                            assert($subSectionEntryNode instanceof SectionEntryNode);
+                            $currentLevel = $menuEntry->getLevel() + 1;
+                            $sectionMenuEntry = new MenuEntryNode($documentEntry->getFile(), $subSectionEntryNode->getTitle(), [], false, $currentLevel, $subSectionEntryNode->getId());
+                            $menuEntry->addSection($sectionMenuEntry);
+                            $this->addSubSections($sectionMenuEntry, $subSectionEntryNode, $documentEntry, $currentLevel);
+                        }
                     }
                 }
+
+                $menuEntries[] = $menuEntry;
+                if (!$glob) {
+                    // If glob is not set, there may only be one result per listed file
+                    break;
+                }
             }
         }
 
@@ -68,6 +82,14 @@ public function leaveNode(Node $node, CompilerContext $compilerContext): Node|nu
         return $node;
     }
 
+    private function addSubSections(MenuEntryNode $sectionMenuEntry, SectionEntryNode $sectionEntryNode, DocumentEntryNode $documentEntry, int $currentLevel): void
+    {
+        foreach ($sectionEntryNode->getChildren() as $subSectionEntryNode) {
+            $sectionMenuEntry = new MenuEntryNode($documentEntry->getFile(), $subSectionEntryNode->getTitle(), [], false, $currentLevel, $subSectionEntryNode->getId());
+            $sectionMenuEntry->addSection($sectionMenuEntry);
+        }
+    }
+
     public function supports(Node $node): bool
     {
         return $node instanceof MenuNode;

packages/guides/src/Compiler/NodeTransformers/TocNodeWithDocumentEntryTransformer.php

@@ -5,12 +5,12 @@
 namespace phpDocumentor\Guides\NodeRenderers\Html;
 
 use phpDocumentor\Guides\NodeRenderers\NodeRenderer;
-use phpDocumentor\Guides\Nodes\Menu\MenuEntry;
+use phpDocumentor\Guides\Nodes\Menu\MenuEntryNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\RenderContext;
 use phpDocumentor\Guides\TemplateRenderer;
 
-/** @implements NodeRenderer<MenuEntry> */
+/** @implements NodeRenderer<MenuEntryNode> */
 final class MenuEntryRenderer implements NodeRenderer
 {
     public function __construct(private readonly TemplateRenderer $renderer)
@@ -19,7 +19,7 @@ public function __construct(private readonly TemplateRenderer $renderer)
 
     public function supports(Node $node): bool
     {
-        return $node instanceof MenuEntry;
+        return $node instanceof MenuEntryNode;
     }
 
     public function render(Node $node, RenderContext $renderContext): string

packages/guides/src/Meta/DocumentReferenceEntry.php

@@ -250,12 +250,9 @@ public function getDocumentEntry(): DocumentEntryNode|null
         return $this->documentEntry;
     }
 
-    public function withDocumentEntry(DocumentEntryNode $documentEntry): DocumentNode
+    public function setDocumentEntry(DocumentEntryNode $documentEntry): void
     {
-        $node = clone$this;
-        $node->documentEntry = $documentEntry;
-
-        return $node;
+        $this->documentEntry = $documentEntry;
     }
 
     public function getRootSectionEntry(): SectionEntryNode|null

packages/guides/src/NodeRenderers/Html/MenuEntryRenderer.php

@@ -9,9 +9,9 @@
 use phpDocumentor\Guides\Nodes\TitleNode;
 
 /** @extends AbstractNode<DocumentNode> */
-class DocumentEntryNode extends AbstractNode implements Entry
+class DocumentEntryNode extends AbstractNode
 {
-    /** @var Entry[] */
+    /** @var DocumentEntryNode[] */
     private array $entries = [];
     /** @var SectionEntryNode[]  */
     private array $sections = [];
@@ -26,12 +26,12 @@ public function getTitle(): TitleNode
         return $this->titleNode;
     }
 
-    public function addChild(Entry $child): void
+    public function addChild(DocumentEntryNode $child): void
     {
         $this->entries[] = $child;
     }
 
-    /** {@inheritDoc} */
+    /** @return DocumentEntryNode[] */
     public function getChildren(): array
     {
         return $this->entries;