在SonataAdmin中手动调整ManyToMany字段内实体的排序

你遇到的核心问题是：ManyToMany关联本身不支持存储顺序，因为默认的中间表只记录两个实体的关联ID，没有用来保存排序位置的字段。要实现手动排序，需要把普通的ManyToMany改成带中间实体的关联结构，具体步骤如下：

1. 创建关联实体（中间表实体） #

新建ContentArticle实体，用来存储Content和Article的关联关系，同时添加position字段保存排序位置：

// src/Entity/ContentArticle.php
namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;

#[ORM\Entity]
#[ORM\UniqueConstraint(name: 'content_article_unique', columns: ['content_id', 'article_id'])]
class ContentArticle
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column(type: 'integer')]
    private $id;

    #[ORM\ManyToOne(targetEntity: Content::class, inversedBy: 'contentArticles')]
    #[ORM\JoinColumn(nullable: false)]
    private $content;

    #[ORM\ManyToOne(targetEntity: Article::class, inversedBy: 'contentArticles')]
    #[ORM\JoinColumn(nullable: false)]
    private $article;

    #[ORM\Column(type: 'integer')]
    private $position = 0;

    // 生成getter和setter方法
    public function getId(): ?int { /* ... */ }
    public function getContent(): ?Content { /* ... */ }
    public function setContent(?Content $content): self { /* ... */ }
    public function getArticle(): ?Article { /* ... */ }
    public function setArticle(?Article $article): self { /* ... */ }
    public function getPosition(): ?int { /* ... */ }
    public function setPosition(int $position): self { /* ... */ }
}

2. 修改Content实体的关联关系 #

把原来的ManyToMany关联改成OneToMany到ContentArticle：

// src/Entity/Content.php
use Doctrine\ORM\Mapping as ORM;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;

#[ORM\Entity]
class Content
{
    // ... 其他字段

    #[ORM\OneToMany(mappedBy: 'content', targetEntity: ContentArticle::class, cascade: ['persist', 'remove'], orphanRemoval: true)]
    #[ORM\OrderBy(['position' => 'ASC'])] // 自动按position排序
    private $contentArticles;

    public function __construct()
    {
        $this->contentArticles = new ArrayCollection();
    }

    // 添加关联方法，替代原来的addArticle/removeArticle
    public function addContentArticle(ContentArticle $contentArticle): self
    {
        if (!$this->contentArticles->contains($contentArticle)) {
            $this->contentArticles[] = $contentArticle;
            $contentArticle->setContent($this);
        }
        return $this;
    }

    public function removeContentArticle(ContentArticle $contentArticle): self
    {
        if ($this->contentArticles->removeElement($contentArticle)) {
            if ($contentArticle->getContent() === $this) {
                $contentArticle->setContent(null);
            }
        }
        return $this;
    }

    // 获取排序后的文章列表（方便前端调用）
    public function getSortedArticles(): Collection
    {
        return $this->contentArticles->map(function(ContentArticle $ca) {
            return $ca->getArticle();
        });
    }
}

3. 修改Article实体（可选，双向关联） #

如果需要从Article端访问关联的Content，添加对应的OneToMany关联：

// src/Entity/Article.php
#[ORM\Entity]
class Article
{
    // ... 其他字段

    #[ORM\OneToMany(mappedBy: 'article', targetEntity: ContentArticle::class, cascade: ['persist', 'remove'])]
    private $contentArticles;

    public function __construct()
    {
        $this->contentArticles = new ArrayCollection();
    }

    // 生成对应的add/removeContentArticle方法
}

4. 更新表单配置 #

使用CollectionType来渲染关联的contentArticles，并启用sortable功能绑定到position字段：

// src/Form/ContentType.php
protected function configureFormFields(FormMapper $form): void
{
    $form
        ->add('title')
        ->add('description')
        ->add('contentArticles', CollectionType::class, [
            'entry_type' => ContentArticleType::class,
            'allow_add' => false, // 如果你已经提前添加好文章关联，这里设为false；如果要在表单添加，设为true
            'allow_delete' => false,
            'by_reference' => false,
            'sortable' => 'position', // 绑定到中间实体的position字段
            'label' => '关联文章'
        ]);
}

然后创建ContentArticleType表单类，用来渲染每个关联项：

// src/Form/ContentArticleType.php
namespace App\Form;

use App\Entity\ContentArticle;
use App\Entity\Article;
use Symfony\Bridge\Doctrine\Form\Type\EntityType;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\Form\Extension\Core\Type\HiddenType;

class ContentArticleType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder
            ->add('article', EntityType::class, [
                'class' => Article::class,
                'choice_label' => 'title',
                'disabled' => true, // 如果不需要在表单修改关联的文章，设为禁用
            ])
            ->add('position', HiddenType::class); // 隐藏字段，用来存储排序位置
    }

    public function configureOptions(OptionsResolver $resolver): void
    {
        $resolver->setDefaults([
            'data_class' => ContentArticle::class,
        ]);
    }
}

5. 处理表单提交后的排序修正（可选） #

为了避免排序位置出现重复或断层，可以在Content实体的生命周期事件中重新整理position值：

// src/Entity/Content.php
use Doctrine\ORM\Mapping as ORM;

#[ORM\Entity]
#[ORM\HasLifecycleCallbacks]
class Content
{
    // ...

    #[ORM\PrePersist]
    #[ORM\PreUpdate]
    public function reorderContentArticles(): void
    {
        $articles = $this->contentArticles->toArray();
        usort($articles, function(ContentArticle $a, ContentArticle $b) {
            return $a->getPosition() - $b->getPosition();
        });

        foreach ($articles as $index => $article) {
            $article->setPosition($index);
        }

        $this->contentArticles = new ArrayCollection($articles);
    }
}

6. 前端展示排序后的文章 #

在前端模板中，调用Content实体的getSortedArticles()方法获取排序后的文章列表：

{# templates/content/show.html.twig #}
{% for article in content.sortedArticles %}
    <div class="article-item">
        <h3>{{ article.title }}</h3>
        <p>{{ article.description }}</p>
    </div>
{% endfor %}

最后执行Doctrine迁移，更新数据库结构：

php bin/console make:migration
php bin/console doctrine:migrations:migrate

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