Symfony 6中为ChoiceType表单字段添加动态选项的问题排查

环境说明 #

• Symfony 6.4.5
• 前端使用Select2组件
• 后端表单采用ChoiceType字段，关联Unit实体的amenity数组字段

相关代码 #

表单类（原代码） #

class UnitEditFormType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder
            ->add('amenity',  ChoiceType::class, [
                'label' => ' ', 
                'expanded' => false, 
                'multiple' => true, 
                'attr' => ["class" => 'form-select multi-selector', 'data-placeholder' => 'This is only a test'], 
                'row_attr' => ['class' => "col-md-6 m-4"] 
            ])
            ->add('save', SubmitType::class, ['label' => 'Save', 'attr' => ['class' => 'btn btn-a']])
            ->addEventListener(FormEvents::PRE_SUBMIT,function (FormEvent $event): void {
                $form = $event->getForm();
                $amenity = $event->getData()['amenity'] ?? NULL;
                if ( !is_null($amenity) && is_array($amenity) ) {
                    foreach($amenity as $item){
                        $options[$item] = $item;
                    }
                    if($amenity){
                        $form->add('amenity', ChoiceType::class, ['choices' => $options]);
                    }
                }
                return;
            } )
        ;
    }

    public function configureOptions(OptionsResolver $resolver): void
    {
        $resolver->setDefaults([
            'csrf_protection' => true,
            'data_class' => 'App\Entity\Unit',
            'attr' => ['class' => 'row']
        ]);
    }
}

Unit实体类（关键片段） #

class Unit
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column]
    private ?int $id = null;
    
    #[ORM\Column(type: Types::ARRAY, nullable: true)]
    private ?array $amenity = null;

    public function getAmenity(): ?array
    {
        return $this->amenity;
    }

    public function setAmenity(?array $amenity): static
    {
        $this->amenity = $amenity;
        return $this;
    }
}

存在的问题 #

1. 启用PRE_SUBMIT事件监听器的form->add逻辑时，出现表单级错误：Submitted data was expected to be text or number, array given.，已确认选项成功添加。
2. 注释掉form->add行时，出现字段级错误：The choices "xxxx" do not exist in the choice list.，提交值可在调试控制台查看。
3. 启用form->add后，若字段已有数据库持久化数据，提交时会触发Warning: Array to string conversion（路径：..\vendor\symfony\form\ChoiceList\ArrayChoiceList.php:67），清空数据库数据后错误消失。

解决方案 #

核心问题是重新添加字段时丢失了原字段的关键配置（如multiple），且未处理已有数据的回显逻辑，以下是修正方案：

1. 修正PRE_SUBMIT事件监听器 #

重新添加字段时必须继承原字段的所有配置，仅覆盖choices选项，避免单值/多值字段类型不匹配：

class UnitEditFormType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder
            ->add('amenity', ChoiceType::class, [
                'label' => ' ',
                'expanded' => false,
                'multiple' => true,
                'attr' => [
                    "class" => 'form-select multi-selector',
                    'data-placeholder' => 'This is only a test'
                ],
                'row_attr' => ['class' => "col-md-6 m-4"],
                'choices' => [] // 初始空选项
            ])
            ->add('save', SubmitType::class, [
                'label' => 'Save',
                'attr' => ['class' => 'btn btn-a']
            ])
            ->addEventListener(FormEvents::PRE_SUBMIT, function (FormEvent $event): void {
                $form = $event->getForm();
                $submittedData = $event->getData();
                $amenityValues = $submittedData['amenity'] ?? [];

                // 获取原字段的完整配置
                $originalConfig = $form->get('amenity')->getConfig();
                $originalOptions = $originalConfig->getOptions();

                // 构建动态选项
                $dynamicChoices = [];
                foreach ($amenityValues as $value) {
                    $dynamicChoices[$value] = $value;
                }

                // 合并配置，仅替换choices
                $newOptions = array_merge($originalOptions, ['choices' => $dynamicChoices]);
                // 替换字段（避免重复添加）
                $form->add('amenity', ChoiceType::class, $newOptions);
            })
        ;
    }

    public function configureOptions(OptionsResolver $resolver): void
    {
        $resolver->setDefaults([
            'csrf_protection' => true,
            'data_class' => Unit::class,
            'attr' => ['class' => 'row']
        ]);
    }
}

2. 处理已有数据的回显 #

添加PRE_SET_DATA事件监听器，在表单初始化时加载已保存的选项，确保编辑时回显正常：

// 在buildForm方法中添加该事件监听器
$builder->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $event): void {
    $unit = $event->getData();
    $form = $event->getForm();

    if ($unit instanceof Unit && $unit->getAmenity()) {
        $existingChoices = [];
        foreach ($unit->getAmenity() as $value) {
            $existingChoices[$value] = $value;
        }

        $originalConfig = $form->get('amenity')->getConfig();
        $originalOptions = $originalConfig->getOptions();

        $form->add('amenity', ChoiceType::class, array_merge($originalOptions, [
            'choices' => $existingChoices
        ]));
    }
});

关键注意事项 #

• 必须保留原字段的multiple配置，否则Symfony会将字段识别为单值字段，导致提交数组时类型错误。
• 处理提交数据时要兼容空值场景（如用户未选择任何选项），避免数组遍历报错。
• PRE_SET_DATA事件用于初始化已有数据的选项，确保编辑页面回显时选项存在。

内容的提问来源于stack exchange，提问作者James