ZIP Imports: Added API examples, finished testing

[bookstack] / app / Activity / Tools / CommentTree.php

diff --git a/app/Activity/Tools/CommentTree.php b/app/Activity/Tools/CommentTree.php
index 559edccf3218c8f0cfc18e8c10658b6912a932d1..a05a9d24726f84ead259de6eb98670bd5b3a9881 100644 (file)
--- a/app/Activity/Tools/CommentTree.php
+++ b/app/Activity/Tools/CommentTree.php
@@ -9,7 +9,7 @@ class CommentTree
 {
     /**
      * The built nested tree structure array.
 {
     /**
      * The built nested tree structure array.

-     * @var array{comment: Comment, depth: int, children: array}[]
+     * @var CommentTreeNode[]

      */
     protected array $tree;
     protected array $comments;
      */
     protected array $tree;
     protected array $comments;


@@ -28,7 +28,7 @@ class CommentTree
 
     public function empty(): bool
     {
 
     public function empty(): bool
     {

-        return count($this->tree) === 0;
+        return count($this->getActive()) === 0;

     }
 
     public function count(): int
     }
 
     public function count(): int


@@ -36,13 +36,51 @@ class CommentTree
         return count($this->comments);
     }
 
         return count($this->comments);
     }
 

-    public function get(): array
+    public function getActive(): array

     {
     {

-        return $this->tree;
+        return array_filter($this->tree, fn (CommentTreeNode $node) => !$node->comment->archived);
+    }
+
+    public function activeThreadCount(): int
+    {
+        return count($this->getActive());
+    }
+
+    public function getArchived(): array
+    {
+        return array_filter($this->tree, fn (CommentTreeNode $node) => $node->comment->archived);
+    }
+
+    public function archivedThreadCount(): int
+    {
+        return count($this->getArchived());
+    }
+
+    public function getCommentNodeForId(int $commentId): ?CommentTreeNode
+    {
+        foreach ($this->tree as $node) {
+            if ($node->comment->id === $commentId) {
+                return $node;
+            }
+        }
+
+        return null;
+    }
+
+    public function canUpdateAny(): bool
+    {
+        foreach ($this->comments as $comment) {
+            if (userCan('comment-update', $comment)) {
+                return true;
+            }
+        }
+
+        return false;

     }
 
     /**
      * @param Comment[] $comments
     }
 
     /**
      * @param Comment[] $comments

+     * @return CommentTreeNode[]

      */
     protected function createTree(array $comments): array
     {
      */
     protected function createTree(array $comments): array
     {


@@ -65,27 +103,23 @@ class CommentTree
         }
 
         $tree = [];
         }
 
         $tree = [];

-        foreach ($childMap[0] as $childId) {
-            $tree[] = $this->createTreeForId($childId, 0, $byId, $childMap);
+        foreach ($childMap[0] ?? [] as $childId) {
+            $tree[] = $this->createTreeNodeForId($childId, 0, $byId, $childMap);

         }
 
         return $tree;
     }
 
         }
 
         return $tree;
     }
 

-    protected function createTreeForId(int $id, int $depth, array &$byId, array &$childMap): array
+    protected function createTreeNodeForId(int $id, int $depth, array &$byId, array &$childMap): CommentTreeNode

     {
         $childIds = $childMap[$id] ?? [];
         $children = [];
 
         foreach ($childIds as $childId) {
     {
         $childIds = $childMap[$id] ?? [];
         $children = [];
 
         foreach ($childIds as $childId) {

-            $children[] = $this->createTreeForId($childId, $depth + 1, $byId, $childMap);
+            $children[] = $this->createTreeNodeForId($childId, $depth + 1, $byId, $childMap);

         }
 
         }
 

-        return [
-            'comment' => $byId[$id],
-            'depth' => $depth,
-            'children' => $children,
-        ];
+        return new CommentTreeNode($byId[$id], $depth, $children);

     }
 
     protected function loadComments(): array
     }
 
     protected function loadComments(): array