Improve typing in ICommentsManager

CarlSchwan · szaimen · commit 7ccf065e7a85 · 2023-05-25T23:12:16.000Z
Signed-off-by: Carl Schwan &lt;carl@carlschwan.eu&gt;
diff --git a/lib/public/Comments/ICommentsManager.php b/lib/public/Comments/ICommentsManager.php
@@ -36,9 +36,6 @@
  *
  * This class manages the access to comments
  *
- * @psalm-type CommentNode = array{comment: IComment, replies: list<CommentNode>}
- * @psalm-type CommentTree = list<CommentNode>
- *
  * @since 9.0.0
  */
 interface ICommentsManager {
@@ -64,11 +61,12 @@ interface ICommentsManager {
 	public function get($id);
 
 	/**
-	 * returns the comment specified by the id and all it's child comments
+	 * Returns the comment specified by the id and all it's child comments
 	 *
 	 * @param string $id
 	 * @param int $limit max number of entries to return, 0 returns all
 	 * @param int $offset the start entry
+	 * @return array{comment: IComment, replies: list<array{comment: IComment, replies: array<empty, empty>}>}
 	 * @since 9.0.0
 	 *
 	 * The return array looks like this

Original file line number	Diff line number	Diff line change
`@@ -36,9 +36,6 @@`
`36`	`36`	`*`
`37`	`37`	`* This class manages the access to comments`
`38`	`38`	`*`
`39`		`- * @psalm-type CommentNode = array{comment: IComment, replies: list<CommentNode>}`
`40`		`- * @psalm-type CommentTree = list<CommentNode>`
`41`		`- *`
`42`	`39`	`* @since 9.0.0`
`43`	`40`	`*/`
`44`	`41`	`interface ICommentsManager {`
`@@ -64,11 +61,12 @@ interface ICommentsManager {`
`64`	`61`	`public function get($id);`
`65`	`62`
`66`	`63`	`/**`
`67`		`- * returns the comment specified by the id and all it's child comments`
	`64`	`+ * Returns the comment specified by the id and all it's child comments`
`68`	`65`	`*`
`69`	`66`	`* @param string $id`
`70`	`67`	`* @param int $limit max number of entries to return, 0 returns all`
`71`	`68`	`* @param int $offset the start entry`
	`69`	`+ * @return array{comment: IComment, replies: list<array{comment: IComment, replies: array<empty, empty>}>}`
`72`	`70`	`* @since 9.0.0`
`73`	`71`	`*`
`74`	`72`	`* The return array looks like this`