-
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
[Form] Add AsFormType attribute to create FormType directly on model classes
#60563
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: 8.1
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\DependencyInjection\Loader\Configurator; | ||
|
|
||
| use Symfony\Component\Form\Metadata\Loader\AttributeLoader; | ||
|
|
||
| return static function (ContainerConfigurator $container) { | ||
| $container->services() | ||
| ->set('form.metadata.attribute_loader', AttributeLoader::class) | ||
|
|
||
| ->alias('form.metadata.default_loader', 'form.metadata.attribute_loader') | ||
| ; | ||
| }; |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Form\Attribute; | ||
|
|
||
| /** | ||
| * Register a model class (e.g. DTO, entity, model, etc...) as a FormType. | ||
| * | ||
| * @author Benjamin Georgeault <git@wedgesama.fr> | ||
| */ | ||
| #[\Attribute(\Attribute::TARGET_CLASS)] | ||
| class AsFormType | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't like the name
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What do you think of:
I have a preference for the 1. And if you have ideas 🙏
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. IMO even if it is not a Form type per se, it is used as a form type. same goes for
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @stof WDYT of answers? |
||
| { | ||
| /** | ||
| * @param array<string, mixed> $options | ||
| */ | ||
| public function __construct( | ||
| private readonly array $options = [], | ||
| ) { | ||
| } | ||
|
|
||
| public function getOptions(): array | ||
| { | ||
| return $this->options; | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Form\Attribute; | ||
|
|
||
| /** | ||
| * Add an AsFormType class property as a FormType's field. | ||
| * | ||
| * @author Benjamin Georgeault <git@wedgesama.fr> | ||
| */ | ||
| #[\Attribute(\Attribute::TARGET_PROPERTY)] | ||
| class Type | ||
| { | ||
| /** | ||
| * @param class-string|null $type the FormType class name to use for this field | ||
| * @param array<string, mixed> $options your form options | ||
| * @param string|null $name change the form view field's name | ||
| */ | ||
| public function __construct( | ||
| private ?string $type = null, | ||
| private array $options = [], | ||
GromNaN marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| private ?string $name = null, | ||
| ) { | ||
| } | ||
|
|
||
| /** | ||
| * @return array<string, mixed> | ||
| */ | ||
| public function getOptions(): array | ||
| { | ||
| return $this->options; | ||
| } | ||
|
|
||
| /** | ||
| * @return class-string|null | ||
| */ | ||
| public function getType(): ?string | ||
| { | ||
| return $this->type; | ||
| } | ||
|
|
||
| public function getName(): ?string | ||
| { | ||
| return $this->name; | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Form\Exception; | ||
|
|
||
| /** | ||
| * Thrown when an error occurred during Metadata creation. | ||
| * | ||
| * @author Benjamin Georgeault <git@wedgesama.fr> | ||
| */ | ||
| class MetadataException extends LogicException | ||
| { | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\Form\Extension\Metadata; | ||
|
|
||
| use Symfony\Component\Form\Exception\InvalidArgumentException; | ||
| use Symfony\Component\Form\Exception\MetadataException; | ||
| use Symfony\Component\Form\Extension\Metadata\Type\MetadataType; | ||
| use Symfony\Component\Form\FormExtensionInterface; | ||
| use Symfony\Component\Form\FormTypeGuesserInterface; | ||
| use Symfony\Component\Form\FormTypeInterface; | ||
| use Symfony\Component\Form\Metadata\Loader\LoaderInterface; | ||
|
|
||
| /** | ||
| * Responsible for instantiating FormType based on a {@see \Symfony\Component\Form\Metadata\FormMetadataInterface}. | ||
| * | ||
| * @author Benjamin Georgeault <git@wedgesama.fr> | ||
| */ | ||
| final class MetadataExtension implements FormExtensionInterface | ||
| { | ||
| /** | ||
| * @var array<class-string, FormTypeInterface> | ||
| */ | ||
| private array $loadedTypes = []; | ||
|
|
||
| public function __construct( | ||
| private readonly LoaderInterface $loader, | ||
| ) { | ||
| } | ||
|
|
||
| public function getType(string $name): FormTypeInterface | ||
| { | ||
| if (null !== $type = $this->loadedTypes[$name] ?? null) { | ||
| return $type; | ||
| } | ||
|
|
||
| try { | ||
| return $this->loadedTypes[$name] = new MetadataType($this->loader->load($name)); | ||
| } catch (MetadataException $e) { | ||
| throw new InvalidArgumentException(\sprintf('Cannot instantiate a "%s" for the given class "%s".', FormTypeInterface::class, $name), previous: $e); | ||
| } | ||
| } | ||
|
|
||
| public function hasType(string $name): bool | ||
| { | ||
| return ($this->loadedTypes[$name] ?? false) || $this->loader->support($name); | ||
| } | ||
|
|
||
| public function getTypeExtensions(string $name): array | ||
| { | ||
| return []; | ||
| } | ||
|
|
||
| public function hasTypeExtensions(string $name): bool | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| public function getTypeGuesser(): ?FormTypeGuesserInterface | ||
| { | ||
| return null; | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using attributes is already opt-in as you have to add the attribute to a class that is autoconfigured. I understand the benefit of this new configuration in avoiding the declaration of unnecessary services, but it would be simpler for users of the framework if they did not need to activate this option.
Unnecessary service (
form.metadata.attribute_loader) can be removed in the compiler pass.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe switch to enable by default instead of disable by default in
src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.phpto keep the possibility to disable, WDYF?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If no
form.metadata.form_typetags exist, the services in the CompilerPass can be removed, eliminating the need for theuse_attributeconfiguration.