Laravel中如何使用枚舉

這篇文章主要介紹“Laravel中如何使用枚舉”的相關知識，小編通過實際案例向大家展示操作過程，操作方法簡單快捷，實用性強，希望這篇“Laravel中如何使用枚舉”文章能幫助大家解決問題。

安裝包

可以通過 composer 在終端中運以下命令來安裝包:

$ composer require bensampo/laravel-enum

如果你使用的是低于5.5的 Laravel 版本，你需要將服務提供者添加到  config/app.php.

'BenSampo\Enum\EnumServiceProvider'

創建第一個枚舉

我們將為用戶類型創建一個枚舉在我們的示例應用程序中，用戶可以屬于以下三種用戶類型之一：管理員、付費成員、成員。

包中包含用于創建枚舉的生成器，因此可以運行以下命令來創建名為UserType的枚舉該文件將在“app/Enums/UserType.php”中創建

php artisan make:enum UserType

你將在這個文件中看到一定數量的腳手架。在文件頂部附近，可能的選項列表被定義為常量。這些常量值存儲在數據庫中，因此我發現最好是使用整數，但是并沒有限制一定要使用整數，只要每一個值都是唯一就可以了了。

本例中的選項看起來是這樣的:

const Administrator = 0;
const PaidMember = 1;
const Member = 2;

把值存儲在數據庫中

現在我們有了一個帶有一些可能性的枚舉，并且可以開始使用它。在遷移 user 表時, 可以添加以下內容。

$table->tinyInteger('type')->unsigned()->default(UserType::Member);

因為 null 不是枚舉的選項，我們需要為它設置默認值。在這個例子中，有必要去假設默認情況下的用戶將成為標準成員。

確保文件的頂部包含此枚舉的 use 語句。

use App\Enums\UserType;

在操作中使用枚舉

由于我們現在的用戶模型具有類型的屬性，我們可以對它進行訪問，并和 enum 值進行比較。這就是枚舉真正的好處，也是我為什么如此喜歡他們。看一下下面的用法示例和可能替代的方法。

if ($user->type === UserType::PaidMember) {
    // 在這里只是做一些付費會員的事情.
}

如果我們不使用枚舉，可能會有類似以下的代碼:

if ($user->type === 1) { // 這個1表示什么??
    // ...
}

if ($user->type === 'PaidMember') { // 這他媽咋么又是字符串 ?
    // ...
}

使用枚舉的第一個例子是最容易讀懂并且也是最不容易出錯的例子。如果我偶然輸入了 UserType::Paidember (注意拼寫錯誤)，我會得到一個很好的錯誤提示，告訴我代碼錯誤了(類中不存在這個常量值)，而不是像前兩個示例那樣默默的失敗。(只是判斷不符合條件，你還需要根據當前的條件語句去具體的查看相關代碼?)

顯示枚舉

在應用的某些界面，我們可能希望向用戶顯示他們所屬的用戶類型。如果只是簡單的輸出從數據庫所獲取的整型值，顯然達不到我們想要的結果。相反，可使用每個枚舉類所繼承基類的  getDescription 方法。

在 blade 模板上的操作如下:

<p>{{ \App\Enums\UserType::getDescription($user->type) }}</p>

輸出結果Administrator(管理員)，PaidMember(付費會員) 、Member(會員)中的一個。

有時候關鍵詞名稱是復合詞(就像 PaidMember)，我們想要展示和鍵名不同的東西。我們可以像下面這樣覆蓋掉當前枚舉的描述。 在 app/Enums/UserType.php:

public static function getDescription(int $value): string
{
    switch ($value) {
        case self::PaidMember:
            return 'Paid member';
        break;
        default:
            return self::getKey($value);
    }
}

現在當我們調用  getDescription 我們將獲取到 Administrator, Paid member or Member.

驗證方式

通過用戶的輸入，對枚舉值進行修改時，最好能確保我們僅僅接受有效的值。我們可以使用包中的驗證規則。

當以表格展示枚舉的時候，我經常把他們顯示為 HTML select 元素。這樣雖仍然可以被惡意修改，但是避免了將錯誤的值傳遞給服務器的情況。

繼續我們的用戶使用示例，讓我們在用戶控制器中處理修改的值:

public function store(Request $request)
{
    $this->validate($request, [
        'type' => ['required', new EnumValue(UserType::class)],
    ]);

    // 保存用戶等等...
}

記住要同時包含枚舉的 use 語句和 EnumValue 的規則。

use App\Enums\UserType;
use BenSampo\Enum\Rules\EnumValue;

關于“Laravel中如何使用枚舉”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識，可以關注億速云行業資訊頻道，小編每天都會為大家更新不同的知識點。