chore(form): add better type information using phpdoc

Signed-off-by: azjezz <[email protected]>

Author: azjezz

AbstractType.php

@@ -16,6 +16,10 @@
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
+ * @template T
+ *
+ * @implements FormTypeInterface<T>
+ *
  * @author Bernhard Schussek <[email protected]>
  */
 abstract class AbstractType implements FormTypeInterface
@@ -36,20 +40,28 @@ public function configureOptions(OptionsResolver $resolver)
     }
 
     /**
+     * @param FormBuilderInterface<T> $builder
+     *
      * @return void
      */
     public function buildForm(FormBuilderInterface $builder, array $options)
     {
     }
 
     /**
+     * @param FormView<T>      $form
+     * @param FormInterface<T> $view
+     *
      * @return void
      */
     public function buildView(FormView $view, FormInterface $form, array $options)
     {
     }
 
     /**
+     * @param FormView<T>      $form
+     * @param FormInterface<T> $view
+     *
      * @return void
      */
     public function finishView(FormView $view, FormInterface $form, array $options)

AbstractTypeExtension.php

@@ -14,6 +14,10 @@
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
+ * @template T
+ *
+ * @implements FormTypeExtensionInterface<T>
+ *
  * @author Bernhard Schussek <[email protected]>
  */
 abstract class AbstractTypeExtension implements FormTypeExtensionInterface
@@ -22,14 +26,25 @@ public function configureOptions(OptionsResolver $resolver): void
     {
     }
 
+    /**
+     * @param FormBuilderInterface<T> $builder
+     */
     public function buildForm(FormBuilderInterface $builder, array $options): void
     {
     }
 
+    /**
+     * @param FormView<T>      $form
+     * @param FormInterface<T> $view
+     */
     public function buildView(FormView $view, FormInterface $form, array $options): void
     {
     }
 
+    /**
+     * @param FormView<T>      $form
+     * @param FormInterface<T> $view
+     */
     public function finishView(FormView $view, FormInterface $form, array $options): void
     {
     }

Event/PostSetDataEvent.php

@@ -19,6 +19,10 @@
  *
  * It can be used to modify a form depending on the populated data (adding or
  * removing fields dynamically).
+ *
+ * @template T
+ *
+ * @extends FormEvent<T>
  */
 final class PostSetDataEvent extends FormEvent
 {

Event/PostSubmitEvent.php

@@ -19,6 +19,10 @@
  * once the model and view data have been denormalized.
  *
  * It can be used to fetch data after denormalization.
+ *
+ * @template T
+ *
+ * @extends FormEvent<T>
  */
 final class PostSubmitEvent extends FormEvent
 {

Event/PreSetDataEvent.php

@@ -17,6 +17,10 @@
  * This event is dispatched at the beginning of the Form::setData() method.
  *
  * It can be used to modify the data given during pre-population.
+ *
+ * @template T
+ *
+ * @extends FormEvent<T>
  */
 final class PreSetDataEvent extends FormEvent
 {

Event/PreSubmitEvent.php

@@ -19,6 +19,8 @@
  * It can be used to:
  *  - Change data from the request, before submitting the data to the form.
  *  - Add or remove form fields, before submitting the data to the form.
+ *
+ * @extends FormEvent<array<string, mixed>>
  */
 final class PreSubmitEvent extends FormEvent
 {

Event/SubmitEvent.php

@@ -18,6 +18,10 @@
  * transforms back the normalized data to the model and view data.
  *
  * It can be used to change data from the normalized representation of the data.
+ *
+ * @template T
+ *
+ * @extends FormEvent<T>
  */
 final class SubmitEvent extends FormEvent
 {

Form.php

@@ -68,7 +68,10 @@
  * @author Fabien Potencier <[email protected]>
  * @author Bernhard Schussek <[email protected]>
  *
+ * @template T
+ *
  * @implements \IteratorAggregate<string, FormInterface>
+ * @implements FormInterface<T>
  */
 #[AssertForm]
 #[Traverse(false)]

FormBuilderInterface.php

@@ -14,6 +14,9 @@
 /**
  * @author Bernhard Schussek <[email protected]>
  *
+ * @template T
+ *
+ * @extends FormConfigBuilderInterface<T>
  * @extends \Traversable<string, FormBuilderInterface>
  */
 interface FormBuilderInterface extends \Traversable, \Countable, FormConfigBuilderInterface
@@ -32,9 +35,9 @@ public function add(string|self $child, ?string $type = null, array $options = [
     /**
      * Creates a form builder.
      *
-     * @param string               $name    The name of the form or the name of the property
-     * @param string|null          $type    The type of the form or null if name is a property
-     * @param array<string, mixed> $options
+     * @param string                               $name    The name of the form or the name of the property
+     * @param class-string<FormTypeInterface>|null $type    The type of the form or null if name is a property
+     * @param array<string, mixed>                 $options
      */
     public function create(string $name, ?string $type = null, array $options = []): self;
 
@@ -64,6 +67,8 @@ public function all(): array;
 
     /**
      * Creates the form.
+     *
+     * @return FormInterface<T>
      */
     public function getForm(): FormInterface;
 }

FormConfigBuilderInterface.php

@@ -13,15 +13,26 @@
 
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\PropertyAccess\PropertyPathInterface;
+use Symfony\Component\Form\Event\PreSetDataEvent;
+use Symfony\Component\Form\Event\PreSubmitEvent;
+use Symfony\Component\Form\Event\PostSetDataEvent;
+use Symfony\Component\Form\Event\SubmitEvent;
+use Symfony\Component\Form\Event\PostSubmitEvent;
 
 /**
+ * @template T
+ *
+ * @extends FormConfigInterface<T>
+ *
  * @author Bernhard Schussek <[email protected]>
  */
 interface FormConfigBuilderInterface extends FormConfigInterface
 {
     /**
      * Adds an event listener to an event on this form.
      *
+     * @param FormEvents::* $eventName
+     * @param (callable(PreSetDataEvent<T>): void)|(callable(PostSetDataEvent<T>): void)|(callable(PreSubmitEvent): void)|(callable(SubmitEvent<T>): void)|(callable(PostSubmitEvent<T>): void) $listener
      * @param int $priority The priority of the listener. Listeners
      *                      with a higher priority are called before
      *                      listeners with a lower priority.
@@ -247,6 +258,8 @@ public function setAutoInitialize(bool $initialize): static;
 
     /**
      * Builds and returns the form configuration.
+     *
+     * @return FormConfigInterface<T>
      */
     public function getFormConfig(): FormConfigInterface;