- partially move PHPStan to level6

sonata-project · Jan 24, 2021 · 9957026 · 9957026
1 parent 1dea724
commit 9957026
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 0 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -217,6 +217,24 @@ parameters:
             count: 1
             path: src/Datagrid/Pager.php
 
+        -
+            # will be fixed in v4. This class will be removed
+            message: "#^Class Sonata\\\\AdminBundle\\\\Admin\\\\Admin extends generic class Sonata\\\\AdminBundle\\\\Admin\\\\AbstractAdmin but does not specify its types\\: T$#"
+            count: 1
+            path: src/Admin/Admin.php
+
+        -
+            # will be fixed in v4. This class will be removed
+            message: "#^Class Sonata\\\\AdminBundle\\\\Admin\\\\AdminExtension extends generic class Sonata\\\\AdminBundle\\\\Admin\\\\AbstractAdminExtension but does not specify its types\\: T$#"
+            count: 1
+            path: src/Admin/AdminExtension.php
+
+        -
+            # will be fixed in v4. Iterator interface will be removed
+            message: "#^Class Sonata\\\\AdminBundle\\\\Datagrid\\\\Pager implements generic interface Iterator but does not specify its types\\: TKey, TValue$#"
+            count: 1
+            path: src/Datagrid/Pager.php
+
 # Symfony related errors
         -
             message: "#^Call to an undefined method Symfony\\\\Component\\\\Config\\\\Definition\\\\Builder\\\\NodeParentInterface\\:\\:arrayNode\\(\\)\\.$#"

diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -13,3 +13,7 @@ parameters:
         - .phpstan/stubs/MetadataInterface.file
         - .phpstan/stubs/Exporter.file
         - .phpstan/stubs/TextExtension.file
+    checkGenericClassInNonGenericObjectType: true
+    checkMissingIterableValueType: true
+    checkMissingVarTagTypehint: true
+    checkMissingTypehints: true
diff --git a/src/Admin/FieldDescriptionCollection.php b/src/Admin/FieldDescriptionCollection.php
@@ -17,21 +17,31 @@
  * @final since sonata-project/admin-bundle 3.52
  *
  * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
+ *
+ * @phpstan-template TValue of FieldDescriptionInterface
+ * @phpstan-implements \ArrayAccess<string,TValue>
  */
 class FieldDescriptionCollection implements \ArrayAccess, \Countable
 {
     /**
      * @var array<string, FieldDescriptionInterface>
+     *
+     * @phpstan-var array<string, TValue>
      */
     protected $elements = [];
 
+    /**
+     * @phpstan-param TValue $fieldDescription
+     */
     public function add(FieldDescriptionInterface $fieldDescription)
     {
         $this->elements[$fieldDescription->getName()] = $fieldDescription;
     }
 
     /**
      * @return array<string, FieldDescriptionInterface>
+     *
+     * @phpstan-return array<string, TValue>
      */
     public function getElements()
     {
@@ -54,6 +64,8 @@ public function has($name)
      * @throws \InvalidArgumentException
      *
      * @return FieldDescriptionInterface
+     *
+     * @phpstan-return TValue
      */
     public function get($name)
     {
@@ -79,6 +91,13 @@ public function offsetExists($offset)
         return $this->has($offset);
     }
 
+    /**
+     * @param string $offset
+     *
+     * @return FieldDescriptionInterface
+     *
+     * @phpstan-return TValue
+     */
     public function offsetGet($offset)
     {
         return $this->get($offset);

diff --git a/src/Datagrid/SimplePager.php b/src/Datagrid/SimplePager.php
@@ -20,6 +20,9 @@
  *
  * @author Lukas Kahwe Smith <smith@pooteeweet.org>
  * @author Sjoerd Peters <sjoerd.peters@gmail.com>
+ *
+ * @phpstan-template T of ProxyQueryInterface
+ * @phpstan-extends Pager<T>
  */
 class SimplePager extends Pager
 {

diff --git a/src/Twig/Extension/SonataAdminExtension.php b/src/Twig/Extension/SonataAdminExtension.php
@@ -568,6 +568,7 @@ public function renderRelationElement($element, FieldDescriptionInterface $field
     public function getUrlSafeIdentifier($model, ?AdminInterface $admin = null)
     {
         if (null === $admin) {
+            /** @phpstan-var class-string $class */
             $class = ClassUtils::getClass($model);
             if (!$this->pool->hasAdminByClass($class)) {
                 throw new \InvalidArgumentException('You must pass an admin.');