Symfony的EntityType多选标签如何保留用户选择的选项顺序？

问题根源 #

Symfony原生EntityType多选组件默认的数据转换器会将提交的ID按表单初始化时查询返回的实体顺序排序，最终返回的实体集合顺序和用户选择顺序无关，因此无法直接满足按选择顺序存储的需求。

实现步骤 #

1. 调整表单配置，自定义数据转换器 #

替换原EntityType为ChoiceType，通过自定义转换器保留提交ID的顺序，再按该顺序组装实体集合：

use Symfony\Component\Form\CallbackTransformer;
use Doctrine\Common\Collections\ArrayCollection;

// 表单类中需要注入TopicRepository，或在控制器中将主题列表传入表单选项
$builder
->add('topics', ChoiceType::class, [
    'choices' => $this->topicRepository->findAll(),
    'choice_label' => 'name',
    'choice_value' => 'id',
    'multiple' => true,
    'label' => 'Topic*'
])
->get('topics')
->addModelTransformer(new CallbackTransformer(
    // 表单渲染阶段：实体集合转ID数组
    function ($selectedTopics) {
        if (null === $selectedTopics) return [];
        return array_map(fn($topic) => $topic->getId(), $selectedTopics->toArray());
    },
    // 表单提交阶段：按提交的ID顺序组装实体集合
    function ($submittedIds) {
        if (empty($submittedIds)) return new ArrayCollection();
        
        // 批量查询选中的主题
        $topics = $this->topicRepository->findBy(['id' => $submittedIds]);
        // 按提交的ID顺序重排实体
        usort($topics, function ($a, $b) use ($submittedIds) {
            return array_search($a->getId(), $submittedIds) - array_search($b->getId(), $submittedIds);
        });
        
        return new ArrayCollection($topics);
    }
));

2. 前端多选组件配置 #

如果使用Select2等前端多选组件，需要开启按选择顺序排列的配置，保证提交的ID数组顺序和用户选择顺序一致：

// Select2 初始化示例
$('select[name*="topics"]').select2({
    selectionOrder: 'selection', // 选中项按选择先后排序
    placeholder: '请选择主题'
});

3. 持久化保留顺序（针对ManyToMany关联场景） #

如果你的主实体和Topic是ManyToMany关联，需要把无额外字段的关联改为带排序字段的关联实体，才能永久存储选择顺序：

1. 新增关联中间实体，添加position排序字段

#[ORM\Entity]
class TopicSortRelation
{
    #[ORM\Id, ORM\GeneratedValue, ORM\Column(type: 'integer')]
    private ?int $id = null;

    #[ORM\ManyToOne(targetEntity: YourMainEntity::class, inversedBy: 'topicRelations')]
    private $mainEntity;

    #[ORM\ManyToOne(targetEntity: Topic::class)]
    private $topic;

    #[ORM\Column(type: 'integer')]
    private int $sort; // 存储选择顺序，从0开始递增

    // 省略getter、setter
}

2. 主实体修改关联为一对多，配置按sort字段排序

// 主实体中
#[ORM\OneToMany(mappedBy: 'mainEntity', targetEntity: TopicSortRelation::class, cascade: ['persist', 'remove'], orphanRemoval: true)]
#[ORM\OrderBy(['sort' => 'ASC'])]
private $topicRelations;

// 新增添加主题的方法
public function addTopic(Topic $topic, int $sort): void
{
    $relation = new TopicSortRelation();
    $relation->setTopic($topic);
    $relation->setSort($sort);
    $relation->setMainEntity($this);
    $this->topicRelations->add($relation);
}

3. 提交后处理关联赋值

// 控制器中拿到表单提交的有序主题集合后
foreach ($form->get('topics')->getData() as $index => $topic) {
    $mainEntity->addTopic($topic, $index);
}

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