minor #51045 [Form] Use logical ordering for type and extension methods (HeahDude)

nicolas-grekas · nicolas-grekas · commit 7a8959bb92f6 · 2023-08-02T16:02:28.000+02:00
This PR was merged into the 6.4 branch. Discussion ---------- [Form] Use logical ordering for type and extension methods | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | ~ | License | MIT | Doc PR | symfony/symfony-docs#18585 Related docs PR has already been merged. IMHO having methods ordered the same way that the component uses them gives a better understanding of how it works (same as having a "supports()" method defined first in a class like `Voter`). It would be nice to reorder them in core implementations as well, by accepting such changes in 5.4, it would not cause conflicts when merging branches, WDYT? Commits ------- 40bfbbd [Form][DX] Use logical ordering for type and extension methods
diff --git a/.github/expected-missing-return-types.diff b/.github/expected-missing-return-types.diff
@@ -694,7 +694,7 @@ diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExt
 +    public function load(array $configs, ContainerBuilder $container): void
      {
          $loader = new PhpFileLoader($container, new FileLocator(\dirname(__DIR__).'/Resources/config'));
-@@ -2941,5 +2941,5 @@ class FrameworkExtension extends Extension
+@@ -2951,5 +2951,5 @@ class FrameworkExtension extends Extension
       * @return void
       */
 -    public static function registerRateLimiter(ContainerBuilder $container, string $name, array $limiterConfig)
@@ -5315,76 +5315,76 @@ diff --git a/src/Symfony/Component/Form/AbstractType.php b/src/Symfony/Component
 --- a/src/Symfony/Component/Form/AbstractType.php
 +++ b/src/Symfony/Component/Form/AbstractType.php
 @@ -24,5 +24,5 @@ abstract class AbstractType implements FormTypeInterface
+      * @return string|null
+      */
+-    public function getParent()
++    public function getParent(): ?string
+     {
+         return FormType::class;
+@@ -32,5 +32,5 @@ abstract class AbstractType implements FormTypeInterface
+      * @return void
+      */
+-    public function configureOptions(OptionsResolver $resolver)
++    public function configureOptions(OptionsResolver $resolver): void
+     {
+     }
+@@ -39,5 +39,5 @@ abstract class AbstractType implements FormTypeInterface
       * @return void
       */
 -    public function buildForm(FormBuilderInterface $builder, array $options)
 +    public function buildForm(FormBuilderInterface $builder, array $options): void
      {
      }
-@@ -31,5 +31,5 @@ abstract class AbstractType implements FormTypeInterface
+@@ -46,5 +46,5 @@ abstract class AbstractType implements FormTypeInterface
       * @return void
       */
 -    public function buildView(FormView $view, FormInterface $form, array $options)
 +    public function buildView(FormView $view, FormInterface $form, array $options): void
      {
      }
-@@ -38,5 +38,5 @@ abstract class AbstractType implements FormTypeInterface
+@@ -53,5 +53,5 @@ abstract class AbstractType implements FormTypeInterface
       * @return void
       */
 -    public function finishView(FormView $view, FormInterface $form, array $options)
 +    public function finishView(FormView $view, FormInterface $form, array $options): void
      {
      }
-@@ -45,5 +45,5 @@ abstract class AbstractType implements FormTypeInterface
-      * @return void
-      */
--    public function configureOptions(OptionsResolver $resolver)
-+    public function configureOptions(OptionsResolver $resolver): void
-     {
-     }
-@@ -52,5 +52,5 @@ abstract class AbstractType implements FormTypeInterface
+@@ -60,5 +60,5 @@ abstract class AbstractType implements FormTypeInterface
       * @return string
       */
 -    public function getBlockPrefix()
 +    public function getBlockPrefix(): string
      {
          return StringUtil::fqcnToBlockPrefix(static::class) ?: '';
-@@ -60,5 +60,5 @@ abstract class AbstractType implements FormTypeInterface
-      * @return string|null
-      */
--    public function getParent()
-+    public function getParent(): ?string
-     {
-         return FormType::class;
 diff --git a/src/Symfony/Component/Form/AbstractTypeExtension.php b/src/Symfony/Component/Form/AbstractTypeExtension.php
 --- a/src/Symfony/Component/Form/AbstractTypeExtension.php
 +++ b/src/Symfony/Component/Form/AbstractTypeExtension.php
 @@ -22,5 +22,5 @@ abstract class AbstractTypeExtension implements FormTypeExtensionInterface
       * @return void
       */
--    public function buildForm(FormBuilderInterface $builder, array $options)
-+    public function buildForm(FormBuilderInterface $builder, array $options): void
+-    public function configureOptions(OptionsResolver $resolver)
++    public function configureOptions(OptionsResolver $resolver): void
      {
      }
 @@ -29,5 +29,5 @@ abstract class AbstractTypeExtension implements FormTypeExtensionInterface
       * @return void
       */
--    public function buildView(FormView $view, FormInterface $form, array $options)
-+    public function buildView(FormView $view, FormInterface $form, array $options): void
+-    public function buildForm(FormBuilderInterface $builder, array $options)
++    public function buildForm(FormBuilderInterface $builder, array $options): void
      {
      }
 @@ -36,5 +36,5 @@ abstract class AbstractTypeExtension implements FormTypeExtensionInterface
       * @return void
       */
--    public function finishView(FormView $view, FormInterface $form, array $options)
-+    public function finishView(FormView $view, FormInterface $form, array $options): void
+-    public function buildView(FormView $view, FormInterface $form, array $options)
++    public function buildView(FormView $view, FormInterface $form, array $options): void
      {
      }
 @@ -43,5 +43,5 @@ abstract class AbstractTypeExtension implements FormTypeExtensionInterface
       * @return void
       */
--    public function configureOptions(OptionsResolver $resolver)
-+    public function configureOptions(OptionsResolver $resolver): void
+-    public function finishView(FormView $view, FormInterface $form, array $options)
++    public function finishView(FormView $view, FormInterface $form, array $options): void
      {
      }
 diff --git a/src/Symfony/Component/Form/ButtonBuilder.php b/src/Symfony/Component/Form/ButtonBuilder.php
@@ -6862,33 +6862,33 @@ diff --git a/src/Symfony/Component/Form/FormRendererInterface.php b/src/Symfony/
 diff --git a/src/Symfony/Component/Form/FormTypeExtensionInterface.php b/src/Symfony/Component/Form/FormTypeExtensionInterface.php
 --- a/src/Symfony/Component/Form/FormTypeExtensionInterface.php
 +++ b/src/Symfony/Component/Form/FormTypeExtensionInterface.php
-@@ -31,5 +31,5 @@ interface FormTypeExtensionInterface
+@@ -29,5 +29,5 @@ interface FormTypeExtensionInterface
+      * @return void
+      */
+-    public function configureOptions(OptionsResolver $resolver);
++    public function configureOptions(OptionsResolver $resolver): void;
+ 
+     /**
+@@ -43,5 +43,5 @@ interface FormTypeExtensionInterface
       * @see FormTypeInterface::buildForm()
       */
 -    public function buildForm(FormBuilderInterface $builder, array $options);
 +    public function buildForm(FormBuilderInterface $builder, array $options): void;
  
      /**
-@@ -45,5 +45,5 @@ interface FormTypeExtensionInterface
+@@ -57,5 +57,5 @@ interface FormTypeExtensionInterface
       * @see FormTypeInterface::buildView()
       */
 -    public function buildView(FormView $view, FormInterface $form, array $options);
 +    public function buildView(FormView $view, FormInterface $form, array $options): void;
  
      /**
-@@ -59,10 +59,10 @@ interface FormTypeExtensionInterface
+@@ -71,4 +71,4 @@ interface FormTypeExtensionInterface
       * @see FormTypeInterface::finishView()
       */
 -    public function finishView(FormView $view, FormInterface $form, array $options);
 +    public function finishView(FormView $view, FormInterface $form, array $options): void;
- 
-     /**
-      * @return void
-      */
--    public function configureOptions(OptionsResolver $resolver);
-+    public function configureOptions(OptionsResolver $resolver): void;
- 
-     /**
+ }
 diff --git a/src/Symfony/Component/Form/FormTypeGuesserInterface.php b/src/Symfony/Component/Form/FormTypeGuesserInterface.php
 --- a/src/Symfony/Component/Form/FormTypeGuesserInterface.php
 +++ b/src/Symfony/Component/Form/FormTypeGuesserInterface.php
@@ -6922,46 +6922,46 @@ diff --git a/src/Symfony/Component/Form/FormTypeGuesserInterface.php b/src/Symfo
 diff --git a/src/Symfony/Component/Form/FormTypeInterface.php b/src/Symfony/Component/Form/FormTypeInterface.php
 --- a/src/Symfony/Component/Form/FormTypeInterface.php
 +++ b/src/Symfony/Component/Form/FormTypeInterface.php
-@@ -31,5 +31,5 @@ interface FormTypeInterface
+@@ -27,5 +27,5 @@ interface FormTypeInterface
+      * @return string|null
+      */
+-    public function getParent();
++    public function getParent(): ?string;
+ 
+     /**
+@@ -34,5 +34,5 @@ interface FormTypeInterface
+      * @return void
+      */
+-    public function configureOptions(OptionsResolver $resolver);
++    public function configureOptions(OptionsResolver $resolver): void;
+ 
+     /**
+@@ -48,5 +48,5 @@ interface FormTypeInterface
       * @see FormTypeExtensionInterface::buildForm()
       */
 -    public function buildForm(FormBuilderInterface $builder, array $options);
 +    public function buildForm(FormBuilderInterface $builder, array $options): void;
  
      /**
-@@ -49,5 +49,5 @@ interface FormTypeInterface
+@@ -66,5 +66,5 @@ interface FormTypeInterface
       * @see FormTypeExtensionInterface::buildView()
       */
 -    public function buildView(FormView $view, FormInterface $form, array $options);
 +    public function buildView(FormView $view, FormInterface $form, array $options): void;
  
      /**
-@@ -68,5 +68,5 @@ interface FormTypeInterface
+@@ -85,5 +85,5 @@ interface FormTypeInterface
       * @see FormTypeExtensionInterface::finishView()
       */
 -    public function finishView(FormView $view, FormInterface $form, array $options);
 +    public function finishView(FormView $view, FormInterface $form, array $options): void;
  
      /**
-@@ -75,5 +75,5 @@ interface FormTypeInterface
-      * @return void
-      */
--    public function configureOptions(OptionsResolver $resolver);
-+    public function configureOptions(OptionsResolver $resolver): void;
- 
-     /**
-@@ -85,5 +85,5 @@ interface FormTypeInterface
+@@ -95,4 +95,4 @@ interface FormTypeInterface
       * @return string
       */
 -    public function getBlockPrefix();
 +    public function getBlockPrefix(): string;
- 
-     /**
-@@ -92,4 +92,4 @@ interface FormTypeInterface
-      * @return string|null
-      */
--    public function getParent();
-+    public function getParent(): ?string;
  }
 diff --git a/src/Symfony/Component/Form/FormView.php b/src/Symfony/Component/Form/FormView.php
 --- a/src/Symfony/Component/Form/FormView.php
@@ -8320,7 +8320,7 @@ diff --git a/src/Symfony/Component/HttpKernel/DependencyInjection/LoggerPass.php
 diff --git a/src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php b/src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php
 --- a/src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php
 +++ b/src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php
-@@ -37,5 +37,5 @@ class RegisterControllerArgumentLocatorsPass implements CompilerPassInterface
+@@ -38,5 +38,5 @@ class RegisterControllerArgumentLocatorsPass implements CompilerPassInterface
       * @return void
       */
 -    public function process(ContainerBuilder $container)
@@ -13056,7 +13056,7 @@ diff --git a/src/Symfony/Component/Validator/Constraints/SequentiallyValidator.p
 diff --git a/src/Symfony/Component/Validator/Constraints/TimeValidator.php b/src/Symfony/Component/Validator/Constraints/TimeValidator.php
 --- a/src/Symfony/Component/Validator/Constraints/TimeValidator.php
 +++ b/src/Symfony/Component/Validator/Constraints/TimeValidator.php
-@@ -37,5 +37,5 @@ class TimeValidator extends ConstraintValidator
+@@ -38,5 +38,5 @@ class TimeValidator extends ConstraintValidator
       * @return void
       */
 -    public function validate(mixed $value, Constraint $constraint)
diff --git a/src/Symfony/Component/Form/AbstractType.php b/src/Symfony/Component/Form/AbstractType.php
@@ -21,46 +21,46 @@
 abstract class AbstractType implements FormTypeInterface
 {
     /**
-     * @return void
+     * @return string|null
      */
-    public function buildForm(FormBuilderInterface $builder, array $options)
+    public function getParent()
     {
+        return FormType::class;
     }
 
     /**
      * @return void
      */
-    public function buildView(FormView $view, FormInterface $form, array $options)
+    public function configureOptions(OptionsResolver $resolver)
     {
     }
 
     /**
      * @return void
      */
-    public function finishView(FormView $view, FormInterface $form, array $options)
+    public function buildForm(FormBuilderInterface $builder, array $options)
     {
     }
 
     /**
      * @return void
      */
-    public function configureOptions(OptionsResolver $resolver)
+    public function buildView(FormView $view, FormInterface $form, array $options)
     {
     }
 
     /**
-     * @return string
+     * @return void
      */
-    public function getBlockPrefix()
+    public function finishView(FormView $view, FormInterface $form, array $options)
     {
-        return StringUtil::fqcnToBlockPrefix(static::class) ?: '';
     }
 
     /**
-     * @return string|null
+     * @return string
      */
-    public function getParent()
+    public function getBlockPrefix()
     {
-        return FormType::class;
+        return StringUtil::fqcnToBlockPrefix(static::class) ?: '';
     }
 }
diff --git a/src/Symfony/Component/Form/AbstractTypeExtension.php b/src/Symfony/Component/Form/AbstractTypeExtension.php
@@ -21,28 +21,28 @@ abstract class AbstractTypeExtension implements FormTypeExtensionInterface
     /**
      * @return void
      */
-    public function buildForm(FormBuilderInterface $builder, array $options)
+    public function configureOptions(OptionsResolver $resolver)
     {
     }
 
     /**
      * @return void
      */
-    public function buildView(FormView $view, FormInterface $form, array $options)
+    public function buildForm(FormBuilderInterface $builder, array $options)
     {
     }
 
     /**
      * @return void
      */
-    public function finishView(FormView $view, FormInterface $form, array $options)
+    public function buildView(FormView $view, FormInterface $form, array $options)
     {
     }
 
     /**
      * @return void
      */
-    public function configureOptions(OptionsResolver $resolver)
+    public function finishView(FormView $view, FormInterface $form, array $options)
     {
     }
 }
diff --git a/src/Symfony/Component/Form/FormTypeExtensionInterface.php b/src/Symfony/Component/Form/FormTypeExtensionInterface.php
@@ -18,6 +18,18 @@
  */
 interface FormTypeExtensionInterface
 {
+    /**
+     * Gets the extended types.
+     *
+     * @return string[]
+     */
+    public static function getExtendedTypes(): iterable;
+
+    /**
+     * @return void
+     */
+    public function configureOptions(OptionsResolver $resolver);
+
     /**
      * Builds the form.
      *
@@ -59,16 +71,4 @@ public function buildView(FormView $view, FormInterface $form, array $options);
      * @see FormTypeInterface::finishView()
      */
     public function finishView(FormView $view, FormInterface $form, array $options);
-
-    /**
-     * @return void
-     */
-    public function configureOptions(OptionsResolver $resolver);
-
-    /**
-     * Gets the extended types.
-     *
-     * @return string[]
-     */
-    public static function getExtendedTypes(): iterable;
 }
diff --git a/src/Symfony/Component/Form/FormTypeInterface.php b/src/Symfony/Component/Form/FormTypeInterface.php

Original file line number	Diff line number	Diff line change
`@@ -21,46 +21,46 @@`
`21`	`21`	`abstract class AbstractType implements FormTypeInterface`
`22`	`22`	`{`
`23`	`23`	`/**`
`24`		`- * @return void`
	`24`	`+ * @return string\|null`
`25`	`25`	`*/`
`26`		`- public function buildForm(FormBuilderInterface $builder, array $options)`
	`26`	`+ public function getParent()`
`27`	`27`	`{`
	`28`	`+ return FormType::class;`
`28`	`29`	`}`
`29`	`30`
`30`	`31`	`/**`
`31`	`32`	`* @return void`
`32`	`33`	`*/`
`33`		`- public function buildView(FormView $view, FormInterface $form, array $options)`
	`34`	`+ public function configureOptions(OptionsResolver $resolver)`
`34`	`35`	`{`
`35`	`36`	`}`
`36`	`37`
`37`	`38`	`/**`
`38`	`39`	`* @return void`
`39`	`40`	`*/`
`40`		`- public function finishView(FormView $view, FormInterface $form, array $options)`
	`41`	`+ public function buildForm(FormBuilderInterface $builder, array $options)`
`41`	`42`	`{`
`42`	`43`	`}`
`43`	`44`
`44`	`45`	`/**`
`45`	`46`	`* @return void`
`46`	`47`	`*/`
`47`		`- public function configureOptions(OptionsResolver $resolver)`
	`48`	`+ public function buildView(FormView $view, FormInterface $form, array $options)`
`48`	`49`	`{`
`49`	`50`	`}`
`50`	`51`
`51`	`52`	`/**`
`52`		`- * @return string`
	`53`	`+ * @return void`
`53`	`54`	`*/`
`54`		`- public function getBlockPrefix()`
	`55`	`+ public function finishView(FormView $view, FormInterface $form, array $options)`
`55`	`56`	`{`
`56`		`- return StringUtil::fqcnToBlockPrefix(static::class) ?: '';`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`/**`
`60`		`- * @return string\|null`
	`60`	`+ * @return string`
`61`	`61`	`*/`
`62`		`- public function getParent()`
	`62`	`+ public function getBlockPrefix()`
`63`	`63`	`{`
`64`		`- return FormType::class;`
	`64`	`+ return StringUtil::fqcnToBlockPrefix(static::class) ?: '';`
`65`	`65`	`}`
`66`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,28 +21,28 @@ abstract class AbstractTypeExtension implements FormTypeExtensionInterface`
`21`	`21`	`/**`
`22`	`22`	`* @return void`
`23`	`23`	`*/`
`24`		`- public function buildForm(FormBuilderInterface $builder, array $options)`
	`24`	`+ public function configureOptions(OptionsResolver $resolver)`
`25`	`25`	`{`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`/**`
`29`	`29`	`* @return void`
`30`	`30`	`*/`
`31`		`- public function buildView(FormView $view, FormInterface $form, array $options)`
	`31`	`+ public function buildForm(FormBuilderInterface $builder, array $options)`
`32`	`32`	`{`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`/**`
`36`	`36`	`* @return void`
`37`	`37`	`*/`
`38`		`- public function finishView(FormView $view, FormInterface $form, array $options)`
	`38`	`+ public function buildView(FormView $view, FormInterface $form, array $options)`
`39`	`39`	`{`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`/**`
`43`	`43`	`* @return void`
`44`	`44`	`*/`
`45`		`- public function configureOptions(OptionsResolver $resolver)`
	`45`	`+ public function finishView(FormView $view, FormInterface $form, array $options)`
`46`	`46`	`{`
`47`	`47`	`}`
`48`	`48`	`}`