[Form] Add form type guesser for `EnumType` #61297

mttsch · 2025-08-01T15:55:31Z

Q	A
Branch?	7.4
Bug fix?	no
New feature?	yes
Deprecations?	no
Issues	Fix #61272
License	MIT

This new form type guesser guesses the form type of an enum property and also sets the class option of the EnumType to the relevant enum name.

src/Symfony/Component/Form/EnumFormTypeGuesser.php

src/Symfony/Bundle/FrameworkBundle/Resources/config/form.php

nicolas-grekas · 2025-08-05T09:46:41Z

src/Symfony/Component/Form/Tests/Fixtures/EnumFormTypeGuesserCase.php

+
+namespace Symfony\Component\Form\Tests\Fixtures;
+
+final class EnumFormTypeGuesserCase


nicolas-grekas · 2025-08-05T09:47:09Z

src/Symfony/Component/Form/Tests/EnumFormTypeGuesserTest.php

+use Symfony\Component\Form\Tests\Fixtures\EnumFormTypeGuesserCase;
+use Symfony\Component\Form\Tests\Fixtures\EnumFormTypeGuesserCaseEnum;
+
+final class EnumFormTypeGuesserTest extends TestCase


final is pure visual overhead ;)

Suggested change

final class EnumFormTypeGuesserTest extends TestCase

class EnumFormTypeGuesserTest extends TestCase

src/Symfony/Component/Form/Tests/EnumFormTypeGuesserTest.php

src/Symfony/Component/Form/EnumFormTypeGuesser.php

nicolas-grekas · 2025-08-05T09:53:28Z

src/Symfony/Component/Form/EnumFormTypeGuesser.php

+
+    public function guessType(string $class, string $property): ?TypeGuess
+    {
+        if (null === ($propertyType = $this->getPropertyType($class, $property))) {


Suggested change

if (null === ($propertyType = $this->getPropertyType($class, $property))) {

if (!$propertyType = $this->getPropertyType($class, $property)) {

nicolas-grekas · 2025-08-05T09:55:10Z

src/Symfony/Component/Form/EnumFormTypeGuesser.php

+
+    private function getPropertyType(string $class, string $property): ?\ReflectionNamedType
+    {
+        if (isset($this->cache[$class]) && \array_key_exists($property, $this->cache[$class])) {


Suggested change

if (isset($this->cache[$class]) && \array_key_exists($property, $this->cache[$class])) {

if (isset($this->cache[$class][$property])) {

nicolas-grekas · 2025-08-05T09:55:37Z

src/Symfony/Component/Form/EnumFormTypeGuesser.php

+        if (!isset($this->cache[$class])) {
+            $this->cache[$class] = [];
+        }
+


Suggested change

if (!isset($this->cache[$class])) {

$this->cache[$class] = [];

}

nicolas-grekas · 2025-08-05T09:55:52Z

src/Symfony/Component/Form/EnumFormTypeGuesser.php

+            $classReflection = new \ReflectionClass($class);
+            $propertyReflection = $classReflection->getProperty($property);
+        } catch (\ReflectionException) {
+            return $this->cache[$class][$property] = null;


Suggested change

return $this->cache[$class][$property] = null;

return $this->cache[$class][$property] = false;

nicolas-grekas · 2025-08-05T09:56:41Z

src/Symfony/Component/Form/EnumFormTypeGuesser.php

+            $classReflection = new \ReflectionClass($class);
+            $propertyReflection = $classReflection->getProperty($property);


Suggested change

$classReflection = new \ReflectionClass($class);

$propertyReflection = $classReflection->getProperty($property);

$propertyReflection = new \ReflectionProperty($class, $property);

nicolas-grekas · 2025-08-05T09:58:57Z

src/Symfony/Component/Form/EnumFormTypeGuesser.php

+        if (!$propertyReflection->getType() instanceof \ReflectionNamedType || !enum_exists($propertyReflection->getType()->getName())) {
+            return $this->cache[$class][$property] = null;
+        }
+
+        return $this->cache[$class][$property] = $propertyReflection->getType();


Suggested change

if (!$propertyReflection->getType() instanceof \ReflectionNamedType || !enum_exists($propertyReflection->getType()->getName())) {

return $this->cache[$class][$property] = null;

}

return $this->cache[$class][$property] = $propertyReflection->getType();

$type = $propertyReflection->getType();

if (!$type instanceof \ReflectionNamedType || !enum_exists($enum->getName())) {

$type = false;

}

return $this->cache[$class][$property] = $type;

xabbuh · 2025-08-05T20:29:00Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

@@ -564,6 +565,10 @@ public function load(array $configs, ContainerBuilder $container): void
            if (!$this->readConfigEnabled('html_sanitizer', $container, $config['html_sanitizer']) || !class_exists(TextTypeHtmlSanitizerExtension::class)) {
                $container->removeDefinition('form.type_extension.form.html_sanitizer');
            }
+
+            if (!class_exists(EnumFormTypeGuesser::class)) {


I would do this inside registerFormConfiguration()

src/Symfony/Component/Form/EnumFormTypeGuesser.php

mttsch · 2025-08-19T18:47:10Z

@nicolas-grekas @xabbuh Is there anything more to do for me in this PR?

xabbuh · 2025-08-22T10:17:35Z

src/Symfony/Component/Form/EnumFormTypeGuesser.php

+            $type = false;
+        }
+
+        return $this->cache[$class][$property] = $type;


Would it be better in terms of memory usage to only store the enum name here (i.e. the result of $type->getName()) instead of a full reflection object?

I am also using the result of $type->allowsNull() in guessRequired(), so that we be two values needed.

Maybe we can add that information in the string by prefixing it with a question mark.

My main concern with the current approach is that I am unsure if it plays well with long running processes where the guesser is used while serving many requests.

by prefixing it with a question mark

done

mttsch requested review from xabbuh and yceruto as code owners August 1, 2025 15:55

carsonbot added Status: Needs Review Feature Form labels Aug 1, 2025

carsonbot added this to the 7.4 milestone Aug 1, 2025

mttsch commented Aug 1, 2025

View reviewed changes

src/Symfony/Component/Form/EnumFormTypeGuesser.php Outdated Show resolved Hide resolved

mttsch force-pushed the feature/61272-form-enum-type-guesser branch 4 times, most recently from 30ce63c to 0796aa4 Compare August 1, 2025 16:27

This comment was marked as outdated.

Sign in to view

mttsch force-pushed the feature/61272-form-enum-type-guesser branch 2 times, most recently from 80d176c to 78a2346 Compare August 3, 2025 03:40

nicolas-grekas reviewed Aug 5, 2025

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Resources/config/form.php Show resolved Hide resolved

mttsch force-pushed the feature/61272-form-enum-type-guesser branch 2 times, most recently from 1fbb523 to a5eebb2 Compare August 5, 2025 09:53

nicolas-grekas reviewed Aug 5, 2025

View reviewed changes

mttsch force-pushed the feature/61272-form-enum-type-guesser branch from a5eebb2 to 1e540eb Compare August 5, 2025 14:51

xabbuh reviewed Aug 5, 2025

View reviewed changes

src/Symfony/Component/Form/EnumFormTypeGuesser.php Outdated Show resolved Hide resolved

xabbuh reviewed Aug 5, 2025

View reviewed changes

src/Symfony/Component/Form/EnumFormTypeGuesser.php Outdated Show resolved Hide resolved

mttsch force-pushed the feature/61272-form-enum-type-guesser branch from 1e540eb to dc492c9 Compare August 6, 2025 03:28

xabbuh reviewed Aug 22, 2025

View reviewed changes

[Form] Add form type guesser for EnumType

7918e76

mttsch force-pushed the feature/61272-form-enum-type-guesser branch from dc492c9 to 7918e76 Compare August 22, 2025 14:31


		namespace Symfony\Component\Form\Tests\Fixtures;

		final class EnumFormTypeGuesserCase

	final class EnumFormTypeGuesserTest extends TestCase
	class EnumFormTypeGuesserTest extends TestCase

	if (null === ($propertyType = $this->getPropertyType($class, $property))) {
	if (!$propertyType = $this->getPropertyType($class, $property)) {

	if (isset($this->cache[$class]) && \array_key_exists($property, $this->cache[$class])) {
	if (isset($this->cache[$class][$property])) {

	if (!isset($this->cache[$class])) {
	$this->cache[$class] = [];
	}

	return $this->cache[$class][$property] = null;
	return $this->cache[$class][$property] = false;

		$classReflection = new \ReflectionClass($class);
		$propertyReflection = $classReflection->getProperty($property);

	$classReflection = new \ReflectionClass($class);
	$propertyReflection = $classReflection->getProperty($property);
	$propertyReflection = new \ReflectionProperty($class, $property);

Uh oh!

[Form] Add form type guesser for EnumType #61297

Are you sure you want to change the base?

[Form] Add form type guesser for EnumType #61297

Conversation

mttsch commented Aug 1, 2025

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mttsch commented Aug 19, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xabbuh Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

[Form] Add form type guesser for `EnumType` #61297

[Form] Add form type guesser for `EnumType` #61297

xabbuh Aug 22, 2025 •

edited

Loading