Eloquent模型中如何优雅使用枚举？konekt/enum-eloquent助你轻松实现-composer-PHP中文网

Eloquent模型中如何优雅使用枚举？konekt/enum-eloquent助你轻松实现

WBOY

发布： 2025-06-21 14:50:16

原创

796人浏览过

在 Laravel 项目开发中，使用枚举类型来表示状态或类型是很常见的需求。例如，一个订单可能具有“待处理”、“已取消”、“已完成”等状态。手动在 Eloquent 模型中处理这些枚举类型与数据库字段之间的转换，不仅代码冗余，而且容易出错。幸运的是，konekt/enum-eloquent 扩展包提供了一种简洁优雅的解决方案，可以自动将 Eloquent 模型中的字段转换为 Konekt 枚举对象。

composer在线学习地址：学习地址

首先，确保你已经安装了 konekt/enum 包，因为 konekt/enum-eloquent 依赖于它。如果没有，可以使用 Composer 安装：

<code>composer require konekt/enum</code>

登录后复制

然后，安装 konekt/enum-eloquent：

<code>composer require konekt/enum-eloquent</code>

登录后复制

接下来，按照以下步骤在你的 Eloquent 模型中使用枚举：

疯狂翻译师App

支持屏幕、图片、视频字幕、文档、漫画等多种翻译，准确率高，操作简单。

104

查看详情

创建枚举类： 首先，你需要创建一个枚举类来定义你的枚举值。例如，创建一个 OrderStatus 枚举类：

<code class="php">namespace App;

use Konekt\Enum\Enum;

class OrderStatus extends Enum
{
    const __DEFAULT = self::PENDING;

    const PENDING   = 'pending';
    const CANCELLED = 'cancelled';
    const COMPLETED = 'completed';
}</code>

登录后复制

在模型中使用 CastsEnums trait： 在你的 Eloquent 模型中引入 CastsEnums trait，并定义 $enums 属性，指定需要转换为枚举的字段及其对应的枚举类：

<code class="php">namespace App;

use Illuminate\Database\Eloquent\Model;
use Konekt\Enum\Eloquent\CastsEnums;

class Order extends Model
{
    use CastsEnums;

    protected $enums = [
        'status' => OrderStatus::class
    ];
}</code>

登录后复制

现在，当你从数据库中检索 Order 模型时，status 字段将会自动转换为 OrderStatus 枚举对象。你可以像下面这样使用它：

<code class="php">$order = Order::create([
    'status' => 'pending'
]);

// $order->status 现在是一个 OrderStatus 枚举对象
echo get_class($order->status); // 输出: App\OrderStatus

echo $order->status->value(); // 输出: 'pending'

echo $order->status->isPending() ? 'yes' : 'no'; // 输出: yes

// 也可以直接赋值枚举对象
$order->status = OrderStatus::COMPLETED();
echo $order->status->value(); // 输出: 'completed'

// 仍然可以赋值标量值
$order->status = 'completed';
echo $order->status->isCompleted() ? 'yes' : 'no'; // 输出: yes</code>

登录后复制

konekt/enum-eloquent 的优势在于：