Laravel Enum 项目教程

Laravel Enum 项目教程

项目介绍

Laravel Enum 是一个为 Laravel 框架设计的枚举库，它提供了一种简单、可扩展且强大的枚举实现方式。该库允许开发者将枚举键值对作为类常量，并提供了一系列全功能的方法，如枚举实例化、标志/位运算枚举、类型提示、属性转换、枚举生成器、验证规则、本地化支持等。

项目快速启动

安装

首先，确保你的项目满足以下要求：

• PHP 8.1 或更高版本
• Laravel 10 或更高版本

然后，通过 Composer 安装 Laravel Enum：

composer require spatie/laravel-enum

基本使用

定义枚举

创建一个枚举类：

<?php

namespace App\Enums;

use Spatie\Enum\Laravel\Enum;

/**
 * @method static self pending()
 * @method static self approved()
 * @method static self rejected()
 */
class StatusEnum extends Enum
{
}

实例化枚举

在代码中使用枚举：

use App\Enums\StatusEnum;

$status = StatusEnum::pending();

类型提示

在方法中使用类型提示：

public function updateStatus(StatusEnum $status): void
{
    // 处理状态更新
}

应用案例和最佳实践

枚举在模型中的应用

在模型中使用枚举进行属性转换：

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use App\Enums\StatusEnum;

class Example extends Model
{
    protected $casts = [
        'status' => StatusEnum::class,
    ];
}

验证规则

在表单请求中使用枚举进行验证：

use Illuminate\Foundation\Http\FormRequest;
use App\Enums\StatusEnum;

class UpdateStatusRequest extends FormRequest
{
    public function rules(): array
    {
        return [
            'status' => ['required', 'enum:' . StatusEnum::class],
        ];
    }
}

典型生态项目

Laravel Schema Builder

在 Laravel 的 Schema Builder 中使用枚举：

use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
use App\Enums\StatusEnum;

Schema::create('examples', function (Blueprint $table) {
    $table->id();
    $table->enum('status', StatusEnum::values());
    $table->timestamps();
});

本地化支持

为枚举提供本地化支持：

use Spatie\Enum\Laravel\Facades\Enum;

Enum::asSelectArray(StatusEnum::class);

在 resources/lang/en/enums.php 中添加本地化字符串：

return [
    'StatusEnum' => [
        'pending' => 'Pending',
        'approved' => 'Approved',
        'rejected' => 'Rejected',
    ],
];

通过以上步骤，你可以在 Laravel 项目中充分利用 Laravel Enum 库的功能，提高代码的可读性和可维护性。