Forms stubs (#138)

Author: zmitic

composer.json

@@ -16,6 +16,7 @@
         "vimeo/psalm": "^4.6.1"
     },
     "require-dev": {
+        "symfony/form": "^4.0 || ^5.0",
         "doctrine/orm": "^2.7",
         "phpunit/phpunit": "~7.5 || ~9.5",
         "symfony/cache-contracts": "^1.0 || ^2.0",

src/Plugin.php

@@ -2,6 +2,7 @@
 
 namespace Psalm\SymfonyPsalmPlugin;
 
+use function array_merge;
 use Doctrine\Common\Annotations\AnnotationRegistry;
 use Psalm\Exception\ConfigException;
 use Psalm\Plugin\PluginEntryPointInterface;
@@ -32,7 +33,7 @@ class Plugin implements PluginEntryPointInterface
      */
     protected function getCommonStubs(): array
     {
-        return glob(__DIR__.'/Stubs/common/*.stubphp') ?: [];
+        return glob(__DIR__.'/Stubs/common/{*,*/*}.stubphp', GLOB_BRACE) ?: [];
     }
 
     /**
@@ -85,7 +86,8 @@ public function __invoke(RegistrationInterface $api, SimpleXMLElement $config =
         $api->registerHooksFromClass(ContainerHandler::class);
 
         $stubs = array_merge(
-            $this->getCommonStubs(), $this->getStubsForMajorVersion(Kernel::MAJOR_VERSION)
+            $this->getCommonStubs(),
+            $this->getStubsForMajorVersion(Kernel::MAJOR_VERSION)
         );
 
         foreach ($stubs as $stubFilePath) {

src/Stubs/common/forms/AbstractType.stubphp

@@ -0,0 +1,11 @@
+<?php
+
+namespace Symfony\Component\Form;
+
+/**
+ * @template T
+ * @implements FormTypeInterface<T>
+ */
+abstract class AbstractType implements FormTypeInterface
+{
+}

src/Stubs/common/forms/AbstractTypeExtension.stubphp

@@ -0,0 +1,11 @@
+<?php
+
+namespace Symfony\Component\Form;
+
+/**
+ * @template T
+ * @implements FormTypeExtensionInterface<T>
+ */
+abstract class AbstractTypeExtension implements FormTypeExtensionInterface
+{
+}

src/Stubs/common/forms/DataTransformerInterface.stubphp

@@ -0,0 +1,26 @@
+<?php
+
+namespace Symfony\Component\Form;
+
+use Symfony\Component\Form\Exception\TransformationFailedException;
+
+/**
+ * @template T
+ * @template R
+ */
+interface DataTransformerInterface
+{
+    /**
+     * @psalm-param ?T $value The value in the original representation
+     *
+     * @psalm-return ?R The value in the transformed representation
+     */
+    public function transform($value);
+
+    /**
+     * @psalm-param ?R $value The value in the transformed representation
+     *
+     * @psalm-return ?T The value in the original representation
+     */
+    public function reverseTransform($value);
+}

src/Stubs/common/forms/Form.stubphp

@@ -0,0 +1,11 @@
+<?php
+
+namespace Symfony\Component\Form;
+
+/**
+ * @template T
+ * @implements FormInterface<T>
+ */
+class Form implements \IteratorAggregate, FormInterface, ClearableErrorsInterface
+{
+}

src/Stubs/common/forms/FormBuilderInterface.stubphp

@@ -0,0 +1,22 @@
+<?php
+
+namespace Symfony\Component\Form;
+
+use Symfony\Component\Form\FormTypeInterface;
+
+/**
+ * @template T
+ * @template-extends FormConfigBuilderInterface<T>
+ */
+interface FormBuilderInterface extends \Traversable, \Countable, FormConfigBuilderInterface
+{
+    /**
+     * @psalm-return FormInterface<T>
+     */
+    public function getForm();
+
+    /**
+     * @psalm-param null|class-string<FormTypeInterface> $type
+     */
+    public function create(string $name, $type = null, array $options = []);
+}

src/Stubs/common/forms/FormConfigBuilderInterface.stubphp

@@ -0,0 +1,27 @@
+<?php
+
+namespace Symfony\Component\Form;
+
+use Symfony\Component\Form\Event\PreSetDataEvent;
+use Symfony\Component\Form\Event\PreSubmitEvent;
+use Symfony\Component\Form\Event\PostSetDataEvent;
+use Symfony\Component\Form\Event\SubmitEvent;
+
+/**
+ * @template T
+ * @template-extends FormConfigInterface<T>
+ */
+interface FormConfigBuilderInterface extends FormConfigInterface
+{
+    /**
+     * @psalm-return FormConfigInterface<T>
+     */
+    public function getFormConfig();
+
+    /**
+     * @psalm-param FormEvents::* $eventName
+     *
+     * @psalm-param callable(PreSetDataEvent<T>)|callable(PostSetDataEvent<T>)|callable(PreSubmitEvent)|callable(SubmitEvent<T>) $listener
+     */
+    public function addEventListener($eventName, $listener, $priority = 0);
+}

src/Stubs/common/forms/FormConfigInterface.stubphp

@@ -0,0 +1,17 @@
+<?php
+
+namespace Symfony\Component\Form;
+
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Component\PropertyAccess\PropertyPathInterface;
+
+/**
+ * @template T
+ */
+interface FormConfigInterface
+{
+    /**
+     * @psalm-return ?T
+     */
+    public function getData();
+}

src/Stubs/common/forms/FormEvent.stubphp

@@ -0,0 +1,21 @@
+<?php
+
+namespace Symfony\Component\Form;
+
+use Symfony\Component\EventDispatcher\Event;
+
+/**
+ * @template T
+ */
+class FormEvent extends Event
+{
+    /**
+     * @psalm-return FormInterface<T>
+     */
+    public function getForm() {}
+
+    /**
+     * @psalm-return ?T
+     */
+    public function getData() {}
+}