Laravel中如何使用枚举

这篇文章主要介绍“Laravel中如何使用枚举”的相关知识，小编通过实际案例向大家展示操作过程，操作方法简单快捷，实用性强，希望这篇“Laravel中如何使用枚举”文章能帮助大家解决问题。

成都创新互联长期为上千客户提供的网站建设服务，团队从业经验10年，关注不同地域、不同群体，并针对不同对象提供差异化的产品和服务；打造开放共赢平台，与合作伙伴共同营造健康的互联网生态环境。为天山企业提供专业的成都网站设计、网站制作，天山网站改版等技术服务。拥有十余年丰富建站经验和众多成功案例,为您定制开发。

安装包

可以通过 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 模板上的操作如下:

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

输出结果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中如何使用枚举”的内容就介绍到这里了，感谢大家的阅读。如果想了解更多行业相关的知识，可以关注创新互联行业资讯频道，小编每天都会为大家更新不同的知识点。