[Tree] Add @template and @template-extends annotations to the Tree repositories (#2556)

* Added `@template` and `@template-extends` annotations to the Tree repositories

* Add more generics

---------

Co-authored-by: Fran Moreno <[email protected]>

Author: 7ochem

CHANGELOG.md

@@ -18,6 +18,9 @@ a release.
 ---
 
 ## [Unreleased]
+### Added
+- Tree: Added `@template` and `@template-extends` annotations to the Tree repositories
+
 ### Changed
 - Dropped support for PHP < 7.4
 - Dropped support for Symfony < 5.4

example/app/Entity/Repository/CategoryRepository.php

@@ -11,8 +11,12 @@
 
 namespace App\Entity\Repository;
 
+use App\Entity\Category;
 use Gedmo\Tree\Entity\Repository\NestedTreeRepository;
 
+/**
+ * @template-extends NestedTreeRepository<Category>
+ */
 final class CategoryRepository extends NestedTreeRepository
 {
 }

phpstan-baseline.neon

@@ -616,7 +616,7 @@ parameters:
 			path: tests/Gedmo/Timestampable/Fixture/ArticleCarbon.php
 
 		-
-			message: "#^Property Gedmo\\\\Tests\\\\Tree\\\\MaterializedPathODMMongoDBRepositoryTest\\:\\:\\$repo \\(Gedmo\\\\Tree\\\\Document\\\\MongoDB\\\\Repository\\\\MaterializedPathRepository\\) does not accept Doctrine\\\\ORM\\\\EntityRepository\\<Gedmo\\\\Tests\\\\Tree\\\\Fixture\\\\Document\\\\Category\\>\\.$#"
+			message: "#^Property Gedmo\\\\Tests\\\\Tree\\\\MaterializedPathODMMongoDBRepositoryTest\\:\\:\\$repo \\(Gedmo\\\\Tree\\\\Document\\\\MongoDB\\\\Repository\\\\MaterializedPathRepository\\<Gedmo\\\\Tests\\\\Tree\\\\Fixture\\\\Document\\\\Category\\>\\) does not accept Doctrine\\\\ORM\\\\EntityRepository\\<Gedmo\\\\Tests\\\\Tree\\\\Fixture\\\\Document\\\\Category\\>\\.$#"
 			count: 1
 			path: tests/Gedmo/Tree/MaterializedPathODMMongoDBRepositoryTest.php
 

src/Tree/Document/MongoDB/Repository/AbstractTreeRepository.php

@@ -22,7 +22,11 @@
 use Gedmo\Tree\TreeListener;
 
 /**
- * @phpstan-extends DocumentRepository<object>
+ * @template T of object
+ *
+ * @phpstan-extends DocumentRepository<T>
+ *
+ * @phpstan-implements RepositoryInterface<T>
  */
 abstract class AbstractTreeRepository extends DocumentRepository implements RepositoryInterface
 {
@@ -40,6 +44,7 @@ abstract class AbstractTreeRepository extends DocumentRepository implements Repo
      */
     protected $repoUtils;
 
+    /** @param ClassMetadata<T> $class */
     public function __construct(DocumentManager $em, UnitOfWork $uow, ClassMetadata $class)
     {
         parent::__construct($em, $uow, $class);

src/Tree/Document/MongoDB/Repository/MaterializedPathRepository.php

@@ -24,6 +24,10 @@
  *
  * @author Gustavo Falco <[email protected]>
  * @author Gediminas Morkevicius <[email protected]>
+ *
+ * @template T of object
+ *
+ * @template-extends AbstractTreeRepository<T>
  */
 class MaterializedPathRepository extends AbstractTreeRepository
 {

src/Tree/Entity/Repository/AbstractTreeRepository.php

@@ -23,7 +23,11 @@
 use Gedmo\Tree\TreeListener;
 
 /**
- * @phpstan-extends EntityRepository<object>
+ * @template T of object
+ *
+ * @template-extends EntityRepository<T>
+ *
+ * @template-implements RepositoryInterface<T>
  */
 abstract class AbstractTreeRepository extends EntityRepository implements RepositoryInterface
 {
@@ -41,6 +45,7 @@ abstract class AbstractTreeRepository extends EntityRepository implements Reposi
      */
     protected $repoUtils;
 
+    /** @param ClassMetadata<T> $class */
     public function __construct(EntityManagerInterface $em, ClassMetadata $class)
     {
         parent::__construct($em, $class);

src/Tree/Entity/Repository/ClosureTreeRepository.php

@@ -23,6 +23,10 @@
  *
  * @author Gustavo Adrian <[email protected]>
  * @author Gediminas Morkevicius <[email protected]>
+ *
+ * @template T of object
+ *
+ * @template-extends AbstractTreeRepository<T>
  */
 class ClosureTreeRepository extends AbstractTreeRepository
 {

src/Tree/Entity/Repository/MaterializedPathRepository.php

@@ -21,6 +21,10 @@
  *
  * @author Gustavo Falco <[email protected]>
  * @author Gediminas Morkevicius <[email protected]>
+ *
+ * @template T of object
+ *
+ * @template-extends AbstractTreeRepository<T>
  */
 class MaterializedPathRepository extends AbstractTreeRepository
 {

src/Tree/Entity/Repository/NestedTreeRepository.php

@@ -28,6 +28,10 @@
  *
  * @author Gediminas Morkevicius <[email protected]>
  *
+ * @template T of object
+ *
+ * @template-extends AbstractTreeRepository<T>
+ *
  * @method persistAsFirstChild($node)
  * @method persistAsFirstChildOf($node, $parent)
  * @method persistAsLastChild($node)

src/Tree/RepositoryInterface.php

@@ -16,6 +16,8 @@
  *
  * @author Gustavo Falco <[email protected]>
  * @author Gediminas Morkevicius <[email protected]>
+ *
+ * @template T of object
  */
 interface RepositoryInterface extends RepositoryUtilsInterface
 {
@@ -26,6 +28,8 @@ interface RepositoryInterface extends RepositoryUtilsInterface
      * @param string $direction
      *
      * @return iterable<int|string, object>
+     *
+     * @phpstan-return iterable<int|string, T>
      */
     public function getRootNodes($sortByField = null, $direction = 'asc');
 
@@ -38,6 +42,10 @@ public function getRootNodes($sortByField = null, $direction = 'asc');
      * @param bool                 $includeNode Flag indicating whether the given node should be included in the results
      *
      * @return array<int|string, object>
+     *
+     * @phpstan-param T $node
+     *
+     * @phpstan-return iterable<int|string, T>
      */
     public function getNodesHierarchy($node = null, $direct = false, array $options = [], $includeNode = false);
 
@@ -53,6 +61,9 @@ public function getNodesHierarchy($node = null, $direct = false, array $options
      * @return iterable<int|string, object> List of children
      *
      * @phpstan-param 'asc'|'desc'|'ASC'|'DESC'|array<int, 'asc'|'desc'|'ASC'|'DESC'> $direction
+     * @phpstan-param T|null $node
+     *
+     * @phpstan-return iterable<int|string, T>
      */
     public function getChildren($node = null, $direct = false, $sortByField = null, $direction = 'ASC', $includeNode = false);