Move template param to the class

sonata-project · Apr 14, 2021 · 82121f7 · 82121f7
1 parent a824dfe
commit 82121f7
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 12 deletions.
diff --git a/src/Admin/AdminInterface.php b/src/Admin/AdminInterface.php
@@ -58,6 +58,7 @@
  * @phpstan-extends AccessRegistryInterface<T>
  * @phpstan-extends UrlGeneratorInterface<T>
  * @phpstan-extends LifecycleHookProviderInterface<T>
+ * @phpstan-extends TaggedAdminInterface<T>
  */
 interface AdminInterface extends TaggedAdminInterface, AccessRegistryInterface, FieldDescriptionRegistryInterface, LifecycleHookProviderInterface, MenuBuilderInterface, ParentAdminInterface, UrlGeneratorInterface, MutableTemplateRegistryAwareInterface
 {

diff --git a/src/DependencyInjection/Admin/AbstractTaggedAdmin.php b/src/DependencyInjection/Admin/AbstractTaggedAdmin.php
@@ -33,6 +33,7 @@
 
 /**
  * @phpstan-template T of object
+ * @phpstan-implements TaggedAdminInterface<T>
  */
 abstract class AbstractTaggedAdmin implements TaggedAdminInterface
 {
@@ -117,6 +118,7 @@ abstract class AbstractTaggedAdmin implements TaggedAdminInterface
      * The Entity or Document manager.
      *
      * @var ModelManagerInterface|null
+     * @phpstan-var ModelManagerInterface<T>|null
      */
     protected $modelManager;
 
@@ -372,7 +374,10 @@ final public function hasFilterPersister(): bool
     }
 
     /**
+     * NEXT_MAJOR: Move the phpdoc to the interface.
+     *
      * @final since sonata-admin/admin-bundle 3.84
+     * @phpstan-param ModelManagerInterface<T> $modelManager
      */
     public function setModelManager(ModelManagerInterface $modelManager)
     {

diff --git a/src/DependencyInjection/Admin/TaggedAdminInterface.php b/src/DependencyInjection/Admin/TaggedAdminInterface.php
@@ -63,6 +63,8 @@
  * @method Pool                             getConfigurationPool()
  * @method void                             setRouteGenerator(RouteGeneratorInterface $routeGenerator)
  * @method RouteGeneratorInterface          getRouteGenerator()
+ *
+ * @phpstan-template T of object
  */
 interface TaggedAdminInterface
 {
@@ -153,11 +155,14 @@ public function getSecurityInformation();
 
     /**
      * NEXT_MAJOR: Uncomment this method.
+     *
+     * @phpstan-param ModelManagerInterface<T>
      */
 //    public function setModelManager(ModelManagerInterface $modelManager): void;
 
     /**
      * @return ModelManagerInterface
+     * @phpstan-return ModelManagerInterface<T>
      */
     public function getModelManager();
 

diff --git a/src/Form/DataTransformer/ArrayToModelTransformer.php b/src/Form/DataTransformer/ArrayToModelTransformer.php
@@ -28,6 +28,7 @@ class ArrayToModelTransformer implements DataTransformerInterface
 {
     /**
      * @var ModelManagerInterface
+     * @phpstan-var ModelManagerInterface<T>
      */
     protected $modelManager;
 
@@ -41,7 +42,8 @@ class ArrayToModelTransformer implements DataTransformerInterface
     /**
      * @param string $className
      *
-     * @phpstan-param class-string<T> $className
+     * @phpstan-param ModelManagerInterface<T> $modelManager
+     * @phpstan-param class-string<T>          $className
      */
     public function __construct(ModelManagerInterface $modelManager, $className)
     {

diff --git a/src/Form/DataTransformer/ModelToIdPropertyTransformer.php b/src/Form/DataTransformer/ModelToIdPropertyTransformer.php
@@ -33,6 +33,7 @@ class ModelToIdPropertyTransformer implements DataTransformerInterface
 {
     /**
      * @var ModelManagerInterface
+     * @phpstan-var ModelManagerInterface<T>
      */
     protected $modelManager;
 
@@ -65,7 +66,8 @@ class ModelToIdPropertyTransformer implements DataTransformerInterface
      * @param callable|null   $toStringCallback
      *
      * @phpstan-template P
-     * @phpstan-param class-string<T> $className
+     * @phpstan-param ModelManagerInterface<T>         $modelManager
+     * @phpstan-param class-string<T>                  $className
      * @phpstan-param null|callable(object, P): string $toStringCallback
      */
     public function __construct(

diff --git a/src/Form/DataTransformer/ModelToIdTransformer.php b/src/Form/DataTransformer/ModelToIdTransformer.php
@@ -27,6 +27,7 @@ class ModelToIdTransformer implements DataTransformerInterface
 {
     /**
      * @var ModelManagerInterface
+     * @phpstan-var ModelManagerInterface<T>
      */
     protected $modelManager;
 
@@ -40,7 +41,8 @@ class ModelToIdTransformer implements DataTransformerInterface
     /**
      * @param string $className
      *
-     * @phpstan-param class-string<T> $className
+     * @phpstan-param ModelManagerInterface<T> $modelManager
+     * @phpstan-param class-string<T>          $className
      */
     public function __construct(ModelManagerInterface $modelManager, $className)
     {

diff --git a/src/Form/DataTransformer/ModelsToArrayTransformer.php b/src/Form/DataTransformer/ModelsToArrayTransformer.php
@@ -37,6 +37,7 @@ class ModelsToArrayTransformer implements DataTransformerInterface
 {
     /**
      * @var ModelManagerInterface
+     * @phpstan-var ModelManagerInterface<T>
      */
     protected $modelManager;
 
@@ -60,7 +61,8 @@ class ModelsToArrayTransformer implements DataTransformerInterface
      * @param ModelManagerInterface            $modelManager
      * @param string                           $class
      *
-     * @phpstan-param class-string<T> $class
+     * @phpstan-param ModelManagerInterface<T> $modelManager
+     * @phpstan-param class-string<T>          $class
      *
      * @throws RuntimeException
      */

diff --git a/src/Model/ModelManagerInterface.php b/src/Model/ModelManagerInterface.php
@@ -28,6 +28,8 @@
  *
  * @method bool supportsQuery(object $query)
  * @method void reverseTransform(object $object, array $array = [])
+ *
+ * @phpstan-template T of object
  */
 interface ModelManagerInterface extends DatagridManagerInterface
 {
@@ -72,7 +74,6 @@ public function delete($object);
      *
      * @return object[] all objects matching the criteria
      *
-     * @phpstan-template T of object
      * @phpstan-param class-string<T> $class
      * @phpstan-return T[]
      */
@@ -84,7 +85,6 @@ public function findBy($class, array $criteria = []);
      *
      * @return object|null an object matching the criteria or null if none match
      *
-     * @phpstan-template T of object
      * @phpstan-param class-string<T> $class
      * @phpstan-return T|null
      */
@@ -96,7 +96,6 @@ public function findOneBy($class, array $criteria = []);
      *
      * @return object|null the object with id or null if not found
      *
-     * @phpstan-template T of object
      * @phpstan-param class-string<T> $class
      * @phpstan-return T|null
      */
@@ -204,7 +203,6 @@ public function getUrlSafeIdentifier($model);
      *
      * @return object
      *
-     * @phpstan-template T of object
      * @phpstan-param class-string<T> $class
      * @phpstan-return T
      */
@@ -291,7 +289,6 @@ public function getSortParameters(FieldDescriptionInterface $fieldDescription, D
      *
      * @return object
      *
-     * @phpstan-template T of object
      * @phpstan-param class-string<T> $class
      * @phpstan-return T
      */
@@ -310,7 +307,6 @@ public function modelReverseTransform($class, array $array = []);
      *
      * @return object
      *
-     * @phpstan-template T of object
      * @phpstan-param class-string<T> $class
      * @phpstan-return T
      */
@@ -346,7 +342,7 @@ public function getDataSourceIterator(
      *
      * @return string[]
      *
-     * @phpstan-param class-string $class
+     * @phpstan-param class-string<T> $class
      */
     public function getExportFields($class);
 
@@ -366,7 +362,7 @@ public function getPaginationParameters(DatagridInterface $datagrid, $page);
      * @param string                 $class
      * @param array<int, int|string> $idx
      *
-     * @phpstan-param class-string $class
+     * @phpstan-param class-string<T> $class
      */
     public function addIdentifiersToQuery($class, ProxyQueryInterface $query, array $idx);
 }