Add missing return types to interfaces

derrabus · nicolas-grekas · commit 3494dfea4332 · 2023-02-16T10:01:12.000+01:00
diff --git a/FormTypeInterface.php b/FormTypeInterface.php
@@ -26,6 +26,8 @@ interface FormTypeInterface
      *
      * @param array<string, mixed> $options
      *
+     * @return void
+     *
      * @see FormTypeExtensionInterface::buildForm()
      */
     public function buildForm(FormBuilderInterface $builder, array $options);
@@ -42,6 +44,8 @@ public function buildForm(FormBuilderInterface $builder, array $options);
      *
      * @param array<string, mixed> $options
      *
+     * @return void
+     *
      * @see FormTypeExtensionInterface::buildView()
      */
     public function buildView(FormView $view, FormInterface $form, array $options);
@@ -59,12 +63,16 @@ public function buildView(FormView $view, FormInterface $form, array $options);
      *
      * @param array<string, mixed> $options
      *
+     * @return void
+     *
      * @see FormTypeExtensionInterface::finishView()
      */
     public function finishView(FormView $view, FormInterface $form, array $options);
 
     /**
      * Configures the options for this type.
+     *
+     * @return void
      */
     public function configureOptions(OptionsResolver $resolver);
 
diff --git a/Tests/Command/DebugCommandTest.php b/Tests/Command/DebugCommandTest.php
@@ -284,7 +284,7 @@ private function createCommandTester(array $namespaces = ['Symfony\Component\For
 
 class FooType extends AbstractType
 {
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setRequired('foo');
         $resolver->setDefined('bar');
diff --git a/Tests/Console/Descriptor/AbstractDescriptorTestCase.php b/Tests/Console/Descriptor/AbstractDescriptorTestCase.php
@@ -159,7 +159,7 @@ private function getFixtureFilename($name)
 
 class FooType extends AbstractType
 {
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setRequired('foo');
         $resolver->setDefined('bar');
diff --git a/Tests/Extension/Csrf/Type/FormTypeCsrfExtensionTest.php b/Tests/Extension/Csrf/Type/FormTypeCsrfExtensionTest.php
@@ -23,7 +23,7 @@
 
 class FormTypeCsrfExtensionTest_ChildType extends AbstractType
 {
-    public function buildForm(FormBuilderInterface $builder, array $options)
+    public function buildForm(FormBuilderInterface $builder, array $options): void
     {
         // The form needs a child in order to trigger CSRF protection by
         // default
diff --git a/Tests/Extension/Validator/Constraints/FormValidatorFunctionalTest.php b/Tests/Extension/Validator/Constraints/FormValidatorFunctionalTest.php
@@ -486,15 +486,15 @@ class Foo
     public $bar;
     public $baz;
 
-    public static function loadValidatorMetadata(ClassMetadata $metadata)
+    public static function loadValidatorMetadata(ClassMetadata $metadata): void
     {
         $metadata->addPropertyConstraint('bar', new NotBlank());
     }
 }
 
 class FooType extends AbstractType
 {
-    public function buildForm(FormBuilderInterface $builder, array $options)
+    public function buildForm(FormBuilderInterface $builder, array $options): void
     {
         $builder
             ->add('bar')
@@ -504,7 +504,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
         ;
     }
 
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefault('data_class', Foo::class);
     }
@@ -516,7 +516,7 @@ class Review
     public $title;
     public $author;
 
-    public static function loadValidatorMetadata(ClassMetadata $metadata)
+    public static function loadValidatorMetadata(ClassMetadata $metadata): void
     {
         $metadata->addPropertyConstraint('title', new NotBlank());
         $metadata->addPropertyConstraint('rating', new NotBlank());
@@ -525,7 +525,7 @@ public static function loadValidatorMetadata(ClassMetadata $metadata)
 
 class ReviewType extends AbstractType
 {
-    public function buildForm(FormBuilderInterface $builder, array $options)
+    public function buildForm(FormBuilderInterface $builder, array $options): void
     {
         $builder
             ->add('rating', IntegerType::class, [
@@ -538,7 +538,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
         ;
     }
 
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefault('data_class', Review::class);
     }
@@ -548,22 +548,22 @@ class Customer
 {
     public $email;
 
-    public static function loadValidatorMetadata(ClassMetadata $metadata)
+    public static function loadValidatorMetadata(ClassMetadata $metadata): void
     {
         $metadata->addPropertyConstraint('email', new NotBlank());
     }
 }
 
 class CustomerType extends AbstractType
 {
-    public function buildForm(FormBuilderInterface $builder, array $options)
+    public function buildForm(FormBuilderInterface $builder, array $options): void
     {
         $builder
             ->add('email')
         ;
     }
 
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefault('data_class', Customer::class);
     }
diff --git a/Tests/Fixtures/AlternatingRowType.php b/Tests/Fixtures/AlternatingRowType.php
@@ -9,7 +9,7 @@
 
 class AlternatingRowType extends AbstractType
 {
-    public function buildForm(FormBuilderInterface $builder, array $options)
+    public function buildForm(FormBuilderInterface $builder, array $options): void
     {
         $builder->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $event) {
             $form = $event->getForm();
diff --git a/Tests/Fixtures/AuthorType.php b/Tests/Fixtures/AuthorType.php
@@ -8,15 +8,15 @@
 
 class AuthorType extends AbstractType
 {
-    public function buildForm(FormBuilderInterface $builder, array $options)
+    public function buildForm(FormBuilderInterface $builder, array $options): void
     {
         $builder
             ->add('firstName')
             ->add('lastName')
         ;
     }
 
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefaults([
             'data_class' => 'Symfony\Component\Form\Tests\Fixtures\Author',
diff --git a/Tests/Fixtures/BlockPrefixedFooTextType.php b/Tests/Fixtures/BlockPrefixedFooTextType.php
@@ -16,7 +16,7 @@
 
 class BlockPrefixedFooTextType extends AbstractType
 {
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefault('block_prefix', 'foo');
     }
diff --git a/Tests/Fixtures/ChoiceSubType.php b/Tests/Fixtures/ChoiceSubType.php
@@ -20,7 +20,7 @@
  */
 class ChoiceSubType extends AbstractType
 {
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefaults(['expanded' => true]);
         $resolver->setNormalizer('choices', fn () => [
diff --git a/Tests/Fixtures/ChoiceTypeExtension.php b/Tests/Fixtures/ChoiceTypeExtension.php
@@ -18,7 +18,7 @@ class ChoiceTypeExtension extends AbstractTypeExtension
 {
     public static $extendedType;
 
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefault('choices', [
             'A' => 'a',
diff --git a/Tests/Fixtures/FooTypeBarExtension.php b/Tests/Fixtures/FooTypeBarExtension.php
@@ -16,12 +16,12 @@
 
 class FooTypeBarExtension extends AbstractTypeExtension
 {
-    public function buildForm(FormBuilderInterface $builder, array $options)
+    public function buildForm(FormBuilderInterface $builder, array $options): void
     {
         $builder->setAttribute('bar', 'x');
     }
 
-    public function getAllowedOptionValues()
+    public function getAllowedOptionValues(): array
     {
         return [
             'a_or_b' => ['c'],
diff --git a/Tests/Fixtures/FooTypeBazExtension.php b/Tests/Fixtures/FooTypeBazExtension.php
@@ -16,7 +16,7 @@
 
 class FooTypeBazExtension extends AbstractTypeExtension
 {
-    public function buildForm(FormBuilderInterface $builder, array $options)
+    public function buildForm(FormBuilderInterface $builder, array $options): void
     {
         $builder->setAttribute('baz', 'x');
     }
diff --git a/Tests/Fixtures/LazyChoiceTypeExtension.php b/Tests/Fixtures/LazyChoiceTypeExtension.php
@@ -19,7 +19,7 @@ class LazyChoiceTypeExtension extends AbstractTypeExtension
 {
     public static $extendedType;
 
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefault('choice_loader', ChoiceList::lazy($this, fn () => [
             'Lazy A' => 'lazy_a',
diff --git a/Tests/Fixtures/NotMappedType.php b/Tests/Fixtures/NotMappedType.php
@@ -16,7 +16,7 @@
 
 class NotMappedType extends AbstractType
 {
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefault('mapped', false);
     }

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,8 @@ interface FormTypeInterface`
`26`	`26`	`*`
`27`	`27`	`* @param array<string, mixed> $options`
`28`	`28`	`*`
	`29`	`+ * @return void`
	`30`	`+ *`
`29`	`31`	`* @see FormTypeExtensionInterface::buildForm()`
`30`	`32`	`*/`
`31`	`33`	`public function buildForm(FormBuilderInterface $builder, array $options);`
`@@ -42,6 +44,8 @@ public function buildForm(FormBuilderInterface $builder, array $options);`
`42`	`44`	`*`
`43`	`45`	`* @param array<string, mixed> $options`
`44`	`46`	`*`
	`47`	`+ * @return void`
	`48`	`+ *`
`45`	`49`	`* @see FormTypeExtensionInterface::buildView()`
`46`	`50`	`*/`
`47`	`51`	`public function buildView(FormView $view, FormInterface $form, array $options);`
`@@ -59,12 +63,16 @@ public function buildView(FormView $view, FormInterface $form, array $options);`
`59`	`63`	`*`
`60`	`64`	`* @param array<string, mixed> $options`
`61`	`65`	`*`
	`66`	`+ * @return void`
	`67`	`+ *`
`62`	`68`	`* @see FormTypeExtensionInterface::finishView()`
`63`	`69`	`*/`
`64`	`70`	`public function finishView(FormView $view, FormInterface $form, array $options);`
`65`	`71`
`66`	`72`	`/**`
`67`	`73`	`* Configures the options for this type.`
	`74`	`+ *`
	`75`	`+ * @return void`
`68`	`76`	`*/`
`69`	`77`	`public function configureOptions(OptionsResolver $resolver);`
`70`	`78`
Original file line number	Diff line number	Diff line change
`@@ -284,7 +284,7 @@ private function createCommandTester(array $namespaces = ['Symfony\Component\For`
`284`	`284`
`285`	`285`	`class FooType extends AbstractType`
`286`	`286`	`{`
`287`		`- public function configureOptions(OptionsResolver $resolver)`
	`287`	`+ public function configureOptions(OptionsResolver $resolver): void`
`288`	`288`	`{`
`289`	`289`	`$resolver->setRequired('foo');`
`290`	`290`	`$resolver->setDefined('bar');`
Original file line number	Diff line number	Diff line change
`@@ -159,7 +159,7 @@ private function getFixtureFilename($name)`
`159`	`159`
`160`	`160`	`class FooType extends AbstractType`
`161`	`161`	`{`
`162`		`- public function configureOptions(OptionsResolver $resolver)`
	`162`	`+ public function configureOptions(OptionsResolver $resolver): void`
`163`	`163`	`{`
`164`	`164`	`$resolver->setRequired('foo');`
`165`	`165`	`$resolver->setDefined('bar');`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`
`24`	`24`	`class FormTypeCsrfExtensionTest_ChildType extends AbstractType`
`25`	`25`	`{`
`26`		`- public function buildForm(FormBuilderInterface $builder, array $options)`
	`26`	`+ public function buildForm(FormBuilderInterface $builder, array $options): void`
`27`	`27`	`{`
`28`	`28`	`// The form needs a child in order to trigger CSRF protection by`
`29`	`29`	`// default`
Original file line number	Diff line number	Diff line change
`@@ -486,15 +486,15 @@ class Foo`
`486`	`486`	`public $bar;`
`487`	`487`	`public $baz;`
`488`	`488`
`489`		`- public static function loadValidatorMetadata(ClassMetadata $metadata)`
	`489`	`+ public static function loadValidatorMetadata(ClassMetadata $metadata): void`
`490`	`490`	`{`
`491`	`491`	`$metadata->addPropertyConstraint('bar', new NotBlank());`
`492`	`492`	`}`
`493`	`493`	`}`
`494`	`494`
`495`	`495`	`class FooType extends AbstractType`
`496`	`496`	`{`
`497`		`- public function buildForm(FormBuilderInterface $builder, array $options)`
	`497`	`+ public function buildForm(FormBuilderInterface $builder, array $options): void`
`498`	`498`	`{`
`499`	`499`	`$builder`
`500`	`500`	`->add('bar')`
`@@ -504,7 +504,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)`
`504`	`504`	`;`
`505`	`505`	`}`
`506`	`506`
`507`		`- public function configureOptions(OptionsResolver $resolver)`
	`507`	`+ public function configureOptions(OptionsResolver $resolver): void`
`508`	`508`	`{`
`509`	`509`	`$resolver->setDefault('data_class', Foo::class);`
`510`	`510`	`}`
`@@ -516,7 +516,7 @@ class Review`
`516`	`516`	`public $title;`
`517`	`517`	`public $author;`
`518`	`518`
`519`		`- public static function loadValidatorMetadata(ClassMetadata $metadata)`
	`519`	`+ public static function loadValidatorMetadata(ClassMetadata $metadata): void`
`520`	`520`	`{`
`521`	`521`	`$metadata->addPropertyConstraint('title', new NotBlank());`
`522`	`522`	`$metadata->addPropertyConstraint('rating', new NotBlank());`
`@@ -525,7 +525,7 @@ public static function loadValidatorMetadata(ClassMetadata $metadata)`
`525`	`525`
`526`	`526`	`class ReviewType extends AbstractType`
`527`	`527`	`{`
`528`		`- public function buildForm(FormBuilderInterface $builder, array $options)`
	`528`	`+ public function buildForm(FormBuilderInterface $builder, array $options): void`
`529`	`529`	`{`
`530`	`530`	`$builder`
`531`	`531`	`->add('rating', IntegerType::class, [`
`@@ -538,7 +538,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)`
`538`	`538`	`;`
`539`	`539`	`}`
`540`	`540`
`541`		`- public function configureOptions(OptionsResolver $resolver)`
	`541`	`+ public function configureOptions(OptionsResolver $resolver): void`
`542`	`542`	`{`
`543`	`543`	`$resolver->setDefault('data_class', Review::class);`
`544`	`544`	`}`
`@@ -548,22 +548,22 @@ class Customer`
`548`	`548`	`{`
`549`	`549`	`public $email;`
`550`	`550`
`551`		`- public static function loadValidatorMetadata(ClassMetadata $metadata)`
	`551`	`+ public static function loadValidatorMetadata(ClassMetadata $metadata): void`
`552`	`552`	`{`
`553`	`553`	`$metadata->addPropertyConstraint('email', new NotBlank());`
`554`	`554`	`}`
`555`	`555`	`}`
`556`	`556`
`557`	`557`	`class CustomerType extends AbstractType`
`558`	`558`	`{`
`559`		`- public function buildForm(FormBuilderInterface $builder, array $options)`
	`559`	`+ public function buildForm(FormBuilderInterface $builder, array $options): void`
`560`	`560`	`{`
`561`	`561`	`$builder`
`562`	`562`	`->add('email')`
`563`	`563`	`;`
`564`	`564`	`}`
`565`	`565`
`566`		`- public function configureOptions(OptionsResolver $resolver)`
	`566`	`+ public function configureOptions(OptionsResolver $resolver): void`
`567`	`567`	`{`
`568`	`568`	`$resolver->setDefault('data_class', Customer::class);`
`569`	`569`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`
`10`	`10`	`class AlternatingRowType extends AbstractType`
`11`	`11`	`{`
`12`		`- public function buildForm(FormBuilderInterface $builder, array $options)`
	`12`	`+ public function buildForm(FormBuilderInterface $builder, array $options): void`
`13`	`13`	`{`
`14`	`14`	`$builder->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $event) {`
`15`	`15`	`$form = $event->getForm();`
Original file line number	Diff line number	Diff line change
`@@ -8,15 +8,15 @@`
`8`	`8`
`9`	`9`	`class AuthorType extends AbstractType`
`10`	`10`	`{`
`11`		`- public function buildForm(FormBuilderInterface $builder, array $options)`
	`11`	`+ public function buildForm(FormBuilderInterface $builder, array $options): void`
`12`	`12`	`{`
`13`	`13`	`$builder`
`14`	`14`	`->add('firstName')`
`15`	`15`	`->add('lastName')`
`16`	`16`	`;`
`17`	`17`	`}`
`18`	`18`
`19`		`- public function configureOptions(OptionsResolver $resolver)`
	`19`	`+ public function configureOptions(OptionsResolver $resolver): void`
`20`	`20`	`{`
`21`	`21`	`$resolver->setDefaults([`
`22`	`22`	`'data_class' => 'Symfony\Component\Form\Tests\Fixtures\Author',`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`
`17`	`17`	`class BlockPrefixedFooTextType extends AbstractType`
`18`	`18`	`{`
`19`		`- public function configureOptions(OptionsResolver $resolver)`
	`19`	`+ public function configureOptions(OptionsResolver $resolver): void`
`20`	`20`	`{`
`21`	`21`	`$resolver->setDefault('block_prefix', 'foo');`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`*/`
`21`	`21`	`class ChoiceSubType extends AbstractType`
`22`	`22`	`{`
`23`		`- public function configureOptions(OptionsResolver $resolver)`
	`23`	`+ public function configureOptions(OptionsResolver $resolver): void`
`24`	`24`	`{`
`25`	`25`	`$resolver->setDefaults(['expanded' => true]);`
`26`	`26`	`$resolver->setNormalizer('choices', fn () => [`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ class ChoiceTypeExtension extends AbstractTypeExtension`
`18`	`18`	`{`
`19`	`19`	`public static $extendedType;`
`20`	`20`
`21`		`- public function configureOptions(OptionsResolver $resolver)`
	`21`	`+ public function configureOptions(OptionsResolver $resolver): void`
`22`	`22`	`{`
`23`	`23`	`$resolver->setDefault('choices', [`
`24`	`24`	`'A' => 'a',`