使用 Doctrine ORM 持久化 PHP 8.1 枚举类型-php教程-PHP中文网

使用 Doctrine ORM 持久化 PHP 8.1 枚举类型

花韻仙語

发布： 2025-07-02 16:30:01

原创

626人浏览过

使用 doctrine orm 持久化 php 8.1 枚举类型

本文将介绍如何在 Symfony 项目中使用 Doctrine ORM 持久化 PHP 8.1 枚举类型。正如文章摘要所述，通过配置实体类的 Column 注解并指定 enumType 属性，即可将枚举类型映射到数据库字段。

Doctrine ORM 对 PHP 8.1 枚举类型的支持

从 2.11 版本开始，Doctrine ORM 原生支持 PHP 8.1 的枚举类型。这意味着开发者可以直接将枚举类型映射为数据库字段，而无需手动实现类型转换逻辑。

实体类配置

要在实体类中将枚举类型映射到数据库字段，需要在属性上使用 #[ORM\Column] 注解，并设置 enumType 属性，其值应为枚举类的完全限定名称。

以下是一个示例：

立即学习“PHP免费学习笔记（深入）”；

namespace App\Entity;

use App\Enum\Suit;
use Doctrine\ORM\Mapping as ORM;

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

    #[ORM\Column(type: 'string', enumType: Suit::class)]
    private ?Suit $suit = null;

    public function getId(): ?int
    {
        return $this->id;
    }

    public function getSuit(): ?Suit
    {
        return $this->suit;
    }

    public function setSuit(?Suit $suit): self
    {
        $this->suit = $suit;

        return $this;
    }
}

登录后复制

在上述代码中，Suit 是一个自定义的枚举类，$suit 属性的类型为 Suit。#[ORM\Column] 注解中的 type 属性被设置为 'string'，同时指定了 enumType 为 Suit::class。这表示 $suit 属性的值将以字符串形式存储在数据库中，而 Doctrine ORM 会自动处理字符串与枚举之间的转换。

枚举类定义

以下是一个典型的 PHP 8.1 枚举类定义示例：

namespace App\Enum;

enum Suit: string {
    case Hearts = 'H';
    case Diamonds = 'D';
    case Clubs = 'C';
    case Spades = 'S';
}

登录后复制

该枚举类定义了四种不同的花色，每个花色都有对应的字符串值。

前端表单处理

在 Symfony 表单中，可以使用 ChoiceType 来展示枚举类型的选项。为此，需要将枚举的所有选项传递给 choices 参数。

use App\Enum\GradeEnum;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

class ProfileType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder
            ->add('grade', ChoiceType::class, [
                'placeholder' => '请选择一个选项',
                'required' => false,
                'choices' => [
                    GradeEnum::D1->name => GradeEnum::D1,
                    GradeEnum::D2->name => GradeEnum::D2,
                    GradeEnum::C1->name => GradeEnum::C1,
                    GradeEnum::C2->name => GradeEnum::C2,
                    GradeEnum::B1->name => GradeEnum::B1,
                    GradeEnum::B2->name => GradeEnum::B2,
                    GradeEnum::A1->name => GradeEnum::A1,
                    GradeEnum::A2->name => GradeEnum::A2,
                    GradeEnum::A3->name => GradeEnum::A3,
                    GradeEnum::A4->name => GradeEnum::A4,
                    GradeEnum::A5->name => GradeEnum::A5,
                    GradeEnum::A5plus->name => GradeEnum::A5plus,
                ],
                'attr' => [
                    'class' => 'mb-3'
                ],
                'label' => '等级'
            ]);
    }

    public function configureOptions(OptionsResolver $resolver): void
    {
        $resolver->setDefaults([
            // 在此处配置表单默认选项
        ]);
    }
}

登录后复制

注意事项

确保使用的 Doctrine ORM 版本不低于 2.11。
数据库中枚举值以字符串形式存储，请确保字段长度足够容纳枚举值的字符串表示。
若使用 MySQL 数据库，建议采用 ENUM 类型以提升性能和数据完整性，但需要注意 Doctrine ORM 并未直接支持 MySQL 的 ENUM 类型，需额外配置。