Fixed compatibility with symfony/forms ^6.3

psalm · Jan 4, 2024 · ec35ce2 · ec35ce2
1 parent 0372122
commit ec35ce2
Show file tree

Hide file tree

Showing 10 changed files with 82 additions and 34 deletions.
diff --git a/composer.json b/composer.json
@@ -13,10 +13,10 @@
         "php": "^7.1 || ^8.0",
         "ext-simplexml": "*",
         "symfony/framework-bundle": "^4.0 || ^5.0 || ^6.0",
-        "vimeo/psalm": "^4.12"
+        "vimeo/psalm": "^5"
     },
     "require-dev": {
-        "symfony/form": "^4.0 || ^5.0 || ^6.0",
+        "symfony/form": "^6.4",
         "doctrine/annotations": "^1.8",
         "doctrine/orm": "^2.7",
         "phpunit/phpunit": "~7.5 || ~9.5",

diff --git a/src/Stubs/common/Component/Form/AbstractType.stubphp b/src/Stubs/common/Component/Form/AbstractType.stubphp
@@ -8,4 +8,26 @@ namespace Symfony\Component\Form;
  */
 abstract class AbstractType implements FormTypeInterface
 {
+    /**
+     * @param FormBuilderInterface<T> $builder
+     *
+     * @return void
+     */
+    public function buildForm(FormBuilderInterface $builder, array $options){}
+
+    /**
+     * @param FormInterface<T> $form
+     * @param FormView<T> $view
+     *
+     * @return void
+     */
+    public function buildView(FormView $view, FormInterface $form, array $options){}
+
+    /**
+     * @param FormInterface<T> $form
+     * @param FormView<T> $view
+     *
+     * @return void
+     */
+    public function finishView(FormView $view, FormInterface $form, array $options){}
 }
diff --git a/src/Stubs/common/Component/Form/AbstractTypeExtension.stubphp b/src/Stubs/common/Component/Form/AbstractTypeExtension.stubphp
@@ -2,10 +2,34 @@
 
 namespace Symfony\Component\Form;
 
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
 /**
  * @template T
  * @implements FormTypeExtensionInterface<T>
  */
 abstract class AbstractTypeExtension implements FormTypeExtensionInterface
 {
+  /**
+   * @param FormBuilderInterface<T> $builder
+   *
+   * @return void
+   */
+  public function buildForm(FormBuilderInterface $builder, array $options){}
+
+  /**
+   * @param FormInterface<T> $form
+   * @param FormView<T> $view
+   *
+   * @return void
+   */
+  public function buildView(FormView $view, FormInterface $form, array $options){}
+
+  /**
+   * @param FormInterface<T> $form
+   * @param FormView<T> $view
+   *
+   * @return void
+   */
+  public function finishView(FormView $view, FormInterface $form, array $options){}
 }
diff --git a/src/Stubs/common/Component/Form/Form.stubphp b/src/Stubs/common/Component/Form/Form.stubphp
@@ -5,6 +5,7 @@ namespace Symfony\Component\Form;
 /**
  * @template T
  * @implements FormInterface<T>
+ * @implements \IteratorAggregate<string, FormInterface>
  */
 class Form implements \IteratorAggregate, FormInterface, ClearableErrorsInterface
 {

diff --git a/src/Stubs/common/Component/Form/FormBuilderInterface.stubphp b/src/Stubs/common/Component/Form/FormBuilderInterface.stubphp
@@ -6,6 +6,7 @@ use Symfony\Component\Form\FormTypeInterface;
 
 /**
  * @template T
+ * @template-extends \Traversable<string, FormBuilderInterface>
  * @template-extends FormConfigBuilderInterface<T>
  */
 interface FormBuilderInterface extends \Traversable, \Countable, FormConfigBuilderInterface

diff --git a/src/Stubs/common/Component/Form/FormInterface.stubphp b/src/Stubs/common/Component/Form/FormInterface.stubphp
@@ -5,6 +5,8 @@ namespace Symfony\Component\Form;
 /**
  * @template T
  * @method void clearErrors(bool $deep)
+ * @extends \ArrayAccess<string, FormInterface>
+ * @extends \Traversable<string, FormInterface>
  */
 interface FormInterface extends \ArrayAccess, \Traversable, \Countable
 {

diff --git a/src/Stubs/common/Component/Form/FormTypeExtensionInterface.stubphp b/src/Stubs/common/Component/Form/FormTypeExtensionInterface.stubphp
@@ -2,31 +2,32 @@
 
 namespace Symfony\Component\Form;
 
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
 /**
  * @template T
  */
 interface FormTypeExtensionInterface
 {
     /**
-     * @psalm-param FormBuilderInterface<T> $builder
+     * @return iterable<class-string<FormTypeInterface>>
      */
-    public function buildForm(FormBuilderInterface $builder, array $options);
+    public static function getExtendedTypes();
 
-    /**
-     * @psalm-param FormView<T> $view
-     * @psalm-param FormInterface<T> $form
-     */
-    public function buildView(FormView $view, FormInterface $form, array $options);
+  /**
+   * @psalm-param FormBuilderInterface<T> $builder
+   */
+  public function buildForm(FormBuilderInterface $builder, array $options);
 
-    /**
-     * @psalm-param FormView<T> $view
-     * @psalm-param FormInterface<T> $form
-     * @psalm-param array<array-key, mixed> $options
-     */
-    public function finishView(FormView $view, FormInterface $form, array $options);
+  /**
+   * @psalm-param FormView<T> $view
+   * @psalm-param FormInterface<T> $form
+   */
+  public function buildView(FormView $view, FormInterface $form, array $options);
 
-    /**
-     * @psalm-return iterable<class-string<FormTypeInterface>>
-     */
-    public static function getExtendedTypes();
+  /**
+   * @psalm-param FormView<T> $view
+   * @psalm-param FormInterface<T> $form
+   */
+  public function finishView(FormView $view, FormInterface $form, array $options);
 }
diff --git a/src/Stubs/common/Component/Form/FormTypeInterface.stubphp b/src/Stubs/common/Component/Form/FormTypeInterface.stubphp
@@ -23,7 +23,6 @@ interface FormTypeInterface
     /**
      * @psalm-param FormView<T> $view
      * @psalm-param FormInterface<T> $form
-     * @psalm-param array<array-key, mixed> $options
      */
     public function finishView(FormView $view, FormInterface $form, array $options);
 }
diff --git a/src/Stubs/common/Component/Form/FormView.stubphp b/src/Stubs/common/Component/Form/FormView.stubphp
@@ -6,16 +6,15 @@ use Symfony\Component\Form\Exception\BadMethodCallException;
 
 /**
  * @template T
+ * @implements \ArrayAccess<int|string, FormView>
+ * @implements \IteratorAggregate<int|string, FormView>
  */
 class FormView implements \ArrayAccess, \IteratorAggregate, \Countable
 {
-    /**
-     * @psalm-suppress MixedArrayAssignment
-     * @psalm-suppress InvalidArrayOffset
-     *
-     * @psalm-var array{value: ?T, attr: array<array-key, mixed>}&array<string, mixed>
-     */
-    public array $vars = [
+  /**
+   * @psalm-var array{value: ?T, attr: array<string, mixed>, ...}
+   */
+    public  $vars = [
         'value' => null,
         'attr' => [],
     ];
@@ -26,7 +25,7 @@ class FormView implements \ArrayAccess, \IteratorAggregate, \Countable
     public $parent;
 
     /**
-     * @psalm-var array<string, FormView>
+     * @psalm-var array<int|string, FormView>
      */
     public $children = [];
 }
diff --git a/tests/acceptance/acceptance/forms/FormView.feature b/tests/acceptance/acceptance/forms/FormView.feature
@@ -40,10 +40,9 @@ Feature: Form view
       """
     When I run Psalm
     Then I see these errors
-      | Type  | Message                                                      |
-      | Trace | $parentView: Symfony\Component\Form\FormView\|null           |
-      | Trace | $children: array<string, Symfony\Component\Form\FormView>    |
-      | Trace | $viewData: User\|null                                        |
-      | Trace | $attr: array<array-key, mixed>                               |
+      | Type  | Message                                                         |
+      | Trace | $parentView: Symfony\Component\Form\FormView\|null              |
+      | Trace | $children: array<int\|string, Symfony\Component\Form\FormView   |
+      | Trace | $viewData: User\|null                                           |
+      | Trace | $attr: array<string, mixed>                                     |
     And I see no other errors
-