您好,欢迎访问一九零五行业门户网

聊聊Laravel中怎么使用枚举

laravel中怎么使用枚举?下面本篇文章给大家介绍一下在 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') { // 这他妈咋么又是字符串 ?    // ...}
使用枚举的第一个例子是最容易读懂并且也是最不容易出错的例子。如果我偶然输入了 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视频教程】
以上就是聊聊laravel中怎么使用枚举的详细内容。
其它类似信息

推荐信息