[Form] Add missing return types to interfaces

Author: derrabus

DataMapperInterface.php

@@ -22,8 +22,10 @@ interface DataMapperInterface
      * The method is responsible for calling {@link FormInterface::setData()}
      * on the children of compound forms, defining their underlying model data.
      *
-     * @param mixed                        $viewData View data of the compound form being initialized
-     * @param FormInterface[]|\Traversable $forms    A list of {@link FormInterface} instances
+     * @param mixed                              $viewData View data of the compound form being initialized
+     * @param \Traversable<mixed, FormInterface> $forms    A list of {@link FormInterface} instances
+     *
+     * @return void
      *
      * @throws Exception\UnexpectedTypeException if the type of the data parameter is not supported
      */
@@ -52,9 +54,11 @@ public function mapDataToForms(mixed $viewData, \Traversable $forms);
      * The model data can be an array or an object, so this second argument is always passed
      * by reference.
      *
-     * @param FormInterface[]|\Traversable $forms    A list of {@link FormInterface} instances
-     * @param mixed                        $viewData The compound form's view data that get mapped
-     *                                               its children model data
+     * @param \Traversable<mixed, FormInterface> $forms     A list of {@link FormInterface} instances
+     * @param mixed                              &$viewData The compound form's view data that get mapped
+     *                                                      its children model data
+     *
+     * @return void
      *
      * @throws Exception\UnexpectedTypeException if the type of the data parameter is not supported
      */

Extension/DataCollector/FormDataCollectorInterface.php

@@ -25,26 +25,36 @@ interface FormDataCollectorInterface extends DataCollectorInterface
 {
     /**
      * Stores configuration data of the given form and its children.
+     *
+     * @return void
      */
     public function collectConfiguration(FormInterface $form);
 
     /**
      * Stores the default data of the given form and its children.
+     *
+     * @return void
      */
     public function collectDefaultData(FormInterface $form);
 
     /**
      * Stores the submitted data of the given form and its children.
+     *
+     * @return void
      */
     public function collectSubmittedData(FormInterface $form);
 
     /**
      * Stores the view variables of the given form view and its children.
+     *
+     * @return void
      */
     public function collectViewVariables(FormView $view);
 
     /**
      * Specifies that the given objects represent the same conceptual form.
+     *
+     * @return void
      */
     public function associateFormWithView(FormInterface $form, FormView $view);
 
@@ -53,6 +63,8 @@ public function associateFormWithView(FormInterface $form, FormView $view);
      * a tree-like data structure.
      *
      * The result can be queried using {@link getData()}.
+     *
+     * @return void
      */
     public function buildPreliminaryFormTree(FormInterface $form);
 
@@ -73,6 +85,8 @@ public function buildPreliminaryFormTree(FormInterface $form);
      * tree, only the view data will be included in the result. If a
      * corresponding {@link FormInterface} exists otherwise, call
      * {@link associateFormWithView()} before calling this method.
+     *
+     * @return void
      */
     public function buildFinalFormTree(FormInterface $form, FormView $view);
 

FormRendererEngineInterface.php

@@ -24,6 +24,8 @@ interface FormRendererEngineInterface
      * @param FormView $view   The view to assign the theme(s) to
      * @param mixed    $themes The theme(s). The type of these themes
      *                         is open to the implementation.
+     *
+     * @return void
      */
     public function setTheme(FormView $view, mixed $themes, bool $useDefaultThemes = true);
 

FormRendererInterface.php

@@ -31,6 +31,8 @@ public function getEngine(): FormRendererEngineInterface;
      *                                   is open to the implementation.
      * @param bool     $useDefaultThemes If true, will use default themes specified
      *                                   in the renderer
+     *
+     * @return void
      */
     public function setTheme(FormView $view, mixed $themes, bool $useDefaultThemes = true);
 

FormTypeExtensionInterface.php

@@ -26,6 +26,8 @@ interface FormTypeExtensionInterface
      *
      * @param array<string, mixed> $options
      *
+     * @return void
+     *
      * @see FormTypeInterface::buildForm()
      */
     public function buildForm(FormBuilderInterface $builder, array $options);
@@ -38,6 +40,8 @@ public function buildForm(FormBuilderInterface $builder, array $options);
      *
      * @param array<string, mixed> $options
      *
+     * @return void
+     *
      * @see FormTypeInterface::buildView()
      */
     public function buildView(FormView $view, FormInterface $form, array $options);
@@ -50,10 +54,15 @@ public function buildView(FormView $view, FormInterface $form, array $options);
      *
      * @param array<string, mixed> $options
      *
+     * @return void
+     *
      * @see FormTypeInterface::finishView()
      */
     public function finishView(FormView $view, FormInterface $form, array $options);
 
+    /**
+     * @return void
+     */
     public function configureOptions(OptionsResolver $resolver);
 
     /**

RequestHandlerInterface.php

@@ -20,6 +20,8 @@ interface RequestHandlerInterface
 {
     /**
      * Submits a form if it was submitted.
+     *
+     * @return void
      */
     public function handleRequest(FormInterface $form, mixed $request = null);
 

ResolvedFormTypeInterface.php

@@ -56,20 +56,26 @@ public function createView(FormInterface $form, FormView $parent = null): FormVi
 
     /**
      * Configures a form builder for the type hierarchy.
+     *
+     * @return void
      */
     public function buildForm(FormBuilderInterface $builder, array $options);
 
     /**
      * Configures a form view for the type hierarchy.
      *
      * It is called before the children of the view are built.
+     *
+     * @return void
      */
     public function buildView(FormView $view, FormInterface $form, array $options);
 
     /**
      * Finishes a form view for the type hierarchy.
      *
      * It is called after the children of the view have been built.
+     *
+     * @return void
      */
     public function finishView(FormView $view, FormInterface $form, array $options);
 

Tests/Extension/Core/Type/FormTypeTest.php

@@ -883,14 +883,14 @@ public function getCurrency()
 
 class MoneyDataMapper implements DataMapperInterface
 {
-    public function mapDataToForms($data, $forms)
+    public function mapDataToForms(mixed $viewData, \Traversable $forms): void
     {
         $forms = iterator_to_array($forms);
-        $forms['amount']->setData($data ? $data->getAmount() : 0);
-        $forms['currency']->setData($data ? $data->getCurrency() : 'EUR');
+        $forms['amount']->setData($viewData ? $viewData->getAmount() : 0);
+        $forms['currency']->setData($viewData ? $viewData->getCurrency() : 'EUR');
     }
 
-    public function mapFormsToData($forms, &$data)
+    public function mapFormsToData(\Traversable $forms, mixed &$viewData): void
     {
         $forms = iterator_to_array($forms);
 
@@ -902,7 +902,7 @@ public function mapFormsToData($forms, &$data)
             throw $failure;
         }
 
-        $data = new Money(
+        $viewData = new Money(
             $forms['amount']->getData(),
             $forms['currency']->getData()
         );