在 Laravel 使用枚舉

我是enums 的忠實粉絲最近，我在一家使用C# 的公司工作，那裡廣泛使用enum，我已經習慣了在找不到它們的時候，能夠找到它們，並想念它們。

我將它們用於任何具有有限一組可能選項的事情，例如一周中的幾天、訂單的狀態，或者，如下面的範例中所示，使用者類型。

使用枚舉有幾個好處：

- 減少因轉置或錯誤輸入數字而導致的錯誤。

- 讓將來改變價值觀變得容易。

- 使程式碼更易於閱讀，這意味著不太可能有錯誤潛入其中。

- 確保前向相容性使用枚舉時，如果將來有人更改與成員名稱對應的值，可以大大降低你的程式碼失敗幾率。

PHP 本身並不支援枚舉，但是使用類別中的常數相當容易實現等價的效果。此外，我還創建了一個名為 laravel-enum 的 Laravel 套件。它允許你存取幫助函數，例如列出鍵和值，將描述附加到值上，以及驗證期望枚舉值的請求。

本指南逐步介紹了安裝的流程 Laravel package 包含用法和最佳實踐的範例。

安裝套件

可以透過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') { // 這他媽咋麼又是字串 

以上是在 Laravel 使用枚舉的詳細內容。更多資訊請關注PHP中文網其他相關文章！