Improve code style of menu pass

(cherry picked from commit a4b8b28)
phpDocumentor · Mar 12, 2024 · caf4b09 · caf4b09
1 parent 451c53b
commit caf4b09
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 30 deletions.
diff --git a/packages/guides/src/Compiler/Passes/GlobalMenuPass.php b/packages/guides/src/Compiler/Passes/GlobalMenuPass.php
@@ -17,6 +17,7 @@
 use phpDocumentor\Guides\Compiler\CompilerPass;
 use phpDocumentor\Guides\Nodes\DocumentNode;
 use phpDocumentor\Guides\Nodes\DocumentTree\DocumentEntryNode;
+use phpDocumentor\Guides\Nodes\DocumentTree\EntryNode;
 use phpDocumentor\Guides\Nodes\DocumentTree\ExternalEntryNode;
 use phpDocumentor\Guides\Nodes\Menu\ExternalMenuEntryNode;
 use phpDocumentor\Guides\Nodes\Menu\InternalMenuEntryNode;
@@ -118,10 +119,11 @@ private function getMenuEntryWithChildren(CompilerContext $compilerContext, Menu
         return $newMenuEntry;
     }
 
+    /** @param EntryNode<DocumentEntryNode|ExternalEntryNode>|ExternalEntryNode $entryNode */
     private function addSubEntries(
         CompilerContext $compilerContext,
         MenuEntryNode $sectionMenuEntry,
-        DocumentEntryNode|ExternalEntryNode $entryNode,
+        EntryNode $entryNode,
         int $currentLevel,
         int $maxDepth,
     ): void {
@@ -138,26 +140,40 @@ private function addSubEntries(
         }
 
         foreach ($entryNode->getMenuEntries() as $subEntryNode) {
-            if ($subEntryNode instanceof DocumentEntryNode) {
-                $subMenuEntry = new InternalMenuEntryNode(
-                    $subEntryNode->getFile(),
-                    $subEntryNode->getTitle(),
-                    [],
-                    false,
-                    $currentLevel,
-                    '',
-                );
-                $sectionMenuEntry->addMenuEntry($subMenuEntry);
-                $this->addSubEntries($compilerContext, $subMenuEntry, $subEntryNode, $currentLevel + 1, $maxDepth);
-            } elseif ($subEntryNode instanceof ExternalEntryNode) {
-                $subMenuEntry = new ExternalMenuEntryNode(
-                    $subEntryNode->getValue(),
-                    TitleNode::fromString($subEntryNode->getTitle()),
-                    $currentLevel,
-                );
-                $sectionMenuEntry->addMenuEntry($subMenuEntry);
-                $this->addSubEntries($compilerContext, $subMenuEntry, $subEntryNode, $currentLevel + 1, $maxDepth);
-            }
+            $subMenuEntry = match ($subEntryNode::class) {
+                DocumentEntryNode::class => $this->createInternalMenuEntry($subEntryNode, $currentLevel),
+                ExternalEntryNode::class => $this->createExternalMenuEntry($subEntryNode, $currentLevel),
+            };
+
+            $sectionMenuEntry->addMenuEntry($subMenuEntry);
+            $this->addSubEntries(
+                $compilerContext,
+                $subMenuEntry,
+                $subEntryNode,
+                $currentLevel + 1,
+                $maxDepth,
+            );
         }
     }
+
+    private function createInternalMenuEntry(DocumentEntryNode $subEntryNode, int $currentLevel): InternalMenuEntryNode
+    {
+        return new InternalMenuEntryNode(
+            $subEntryNode->getFile(),
+            $subEntryNode->getTitle(),
+            [],
+            false,
+            $currentLevel,
+            '',
+        );
+    }
+
+    private function createExternalMenuEntry(ExternalEntryNode $subEntryNode, int $currentLevel): ExternalMenuEntryNode
+    {
+        return new ExternalMenuEntryNode(
+            $subEntryNode->getValue(),
+            TitleNode::fromString($subEntryNode->getTitle()),
+            $currentLevel,
+        );
+    }
 }
diff --git a/packages/guides/src/Nodes/DocumentTree/DocumentEntryNode.php b/packages/guides/src/Nodes/DocumentTree/DocumentEntryNode.php
@@ -13,10 +13,12 @@
 
 namespace phpDocumentor\Guides\Nodes\DocumentTree;
 
-use phpDocumentor\Guides\Nodes\DocumentNode;
 use phpDocumentor\Guides\Nodes\TitleNode;
 
-/** @extends EntryNode<DocumentNode> */
+use function array_filter;
+use function array_values;
+
+/** @extends EntryNode<DocumentEntryNode|ExternalEntryNode> */
 final class DocumentEntryNode extends EntryNode
 {
     /** @var array<DocumentEntryNode|ExternalEntryNode> */
@@ -41,21 +43,18 @@ public function addChild(DocumentEntryNode|ExternalEntryNode $child): void
         $this->entries[] = $child;
     }
 
-    /**
-     * @return array<DocumentEntryNode>
-     */
+    /** @return array<DocumentEntryNode> */
     public function getChildren(): array
     {
         // Filter the entries array to only include DocumentEntryNode instances
-        $documentEntries = array_filter($this->entries, function ($entry) {
+        $documentEntries = array_filter($this->entries, static function ($entry) {
             return $entry instanceof DocumentEntryNode;
         });
 
         // Re-index the array to maintain numeric keys
         return array_values($documentEntries);
     }
 
-
     /** @return array<DocumentEntryNode|ExternalEntryNode> */
     public function getMenuEntries(): array
     {

diff --git a/packages/guides/src/Renderer/DocumentTreeIterator.php b/packages/guides/src/Renderer/DocumentTreeIterator.php
@@ -18,8 +18,6 @@
 use phpDocumentor\Guides\Nodes\DocumentTree\DocumentEntryNode;
 use RecursiveIterator;
 
-use function array_filter;
-
 /**
  * Iterates over the document tree and returns the documents in the table of contents order.
  *