聊聊Laravel中怎麼使用列舉

Laravel 9 保姆級視訊教學，想學不會都難！進入學習

我是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') { // 這他媽咋麼又是字串 ?
    // ...
}

使用列舉的第一個例子是最容易讀懂並且也是最不容易出錯的例子。如果我偶然輸入了 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;

結束

當然這並不是列舉所能完成的全部範圍。但是它覆蓋了90%的用例。

值得一看的列表 列舉類上的方法的完整列表 以檢視您還能實現什麼。

【相關推薦：】

以上就是聊聊Laravel中怎麼使用列舉的詳細內容，更多請關注TW511.COM其它相關文章！