How to use enumerations in Laravel? The following article will introduce to you how to use enumerations in Laravel. I hope it will be helpful to you!
I'm a big fan of enums. Lately I've worked for a company using C# where enums are used extensively, and I've become accustomed to being able to, when I can't find them, Find them and miss them.
I use them for anything that has a limited set of possible options, such as the day of the week, the status of an order, or, as in the example below, the user type.
Using enumerations has several benefits:
- Reduces errors caused by transposition or incorrectly entered numbers.
- Makes it easy to change values in the future.
- Makes the code easier to read, which means bugs are less likely to sneak into it.
- Ensure Forward Compatibility When using enumerations, you can greatly reduce the chance of your code failing if someone changes the value corresponding to the member name in the future.
PHP itself does not support enumerations, but it is quite easy to achieve equivalent effects using constants in classes. Additionally, I created a Laravel package called laravel-enum. It allows you to access helper functions such as listing keys and values, appending descriptions to values, and validating requests that expect enumeration values.
This guide walks through the process of installing a Laravel package including examples of usage and best practices.
Installation package
You can run the following command in the terminal through composer to install the package:
$ composer require bensampo/laravel-enum
If you are using Laravel lower than 5.5 version, you need to add the service provider to config/app.php
.
'BenSampo\Enum\EnumServiceProvider'
Create the first enum
We will User Types Create an Enumeration In our sample application, users can belong to one of three user types: Admin, Paid Member, Member.
The package contains generators for creating enumerations, so you can run the following command to create an enumeration named UserType. The file will be created in "app/Enums/UserType.php"
php artisan make:enum UserType
You will see a certain amount of scaffolding in this file. Near the top of the file, the list of possible options is defined as constants. These constant values are stored in the database, so I found it best to use integers, but there is no restriction on using integers as long as each value is unique.
The options in this example look like this:
const Administrator = 0; const PaidMember = 1; const Member = 2;
Store the value in the database
Now we have a Enumeration of possibilities and can start using it. When migrating the user table, you can add the following.
$table->tinyInteger('type')->unsigned()->default(UserType::Member);
Because null is not an option for the enumeration, we need to set a default value for it. In this example, it is necessary to assume that the default user will become a standard member.
Make sure the top of the file contains the use statement for this enumeration.
use App\Enums\UserType;
Using enumerations in operations
Since our current user model has a property of type, we can access it and compare it to the enum value. This is the real benefit of enums, and why I like them so much. Take a look at the usage examples and possible alternatives below.
if ($user->type === UserType::PaidMember) { // 在这里只是做一些付费会员的事情. }
If we don't use enumerations, we may have code similar to the following:
if ($user->type === 1) { // 这个1表示什么?? // ... } if ($user->type === 'PaidMember') { // 这他妈咋么又是字符串 ? // ... }
The first example using an enumeration is the easiest to read and the least error-prone example. . If I accidentally type UserType::Paidember
(note the misspelling), I get a nice error message telling me that the code is wrong (this constant value does not exist in the class), instead of the previous Both examples fail silently. (Just to judge that the conditions are not met, you also need to check the relevant code specifically based on the current conditional statement?)
Display enumeration
In some interfaces of the application , we might want to show the user which user type they are. If we simply output the integer value obtained from the database, we obviously cannot achieve the results we want. Instead, use the getDescription
method of the base class that each enumeration class inherits.
The operations on the blade template are as follows:
<p>{{ \App\Enums\UserType::getDescription($user->type) }}</p>
Output resultsAdministrator
(administrator), PaidMember
(paid member), One of Member
.
Sometimes the keyword name is a compound word (like PaidMember
), and we want to display something different from the key name. We can overwrite the current enumeration description as follows. In 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); } }
Now when we call getDescription
we will get Administrator
, Paid member
or Member
.
Verification method
When modifying the enumeration value through user input, it is best to ensure that we Only valid values are accepted. We can use validation rules from the package.
当以表格展示枚举的时候,我经常把他们显示为 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视频教程】
The above is the detailed content of Let's talk about how to use enumerations in Laravel. For more information, please follow other related articles on the PHP Chinese website!

本篇文章给大家带来了关于laravel的相关知识,其中主要介绍了关于单点登录的相关问题,单点登录是指在多个应用系统中,用户只需要登录一次就可以访问所有相互信任的应用系统,下面一起来看一下,希望对大家有帮助。

本篇文章给大家带来了关于laravel的相关知识,其中主要介绍了关于Laravel的生命周期相关问题,Laravel 的生命周期从public\index.php开始,从public\index.php结束,希望对大家有帮助。

在laravel中,guard是一个用于用户认证的插件;guard的作用就是处理认证判断每一个请求,从数据库中读取数据和用户输入的对比,调用是否登录过或者允许通过的,并且Guard能非常灵活的构建一套自己的认证体系。

laravel中asset()方法的用法:1、用于引入静态文件,语法为“src="{{asset(‘需要引入的文件路径’)}}"”;2、用于给当前请求的scheme前端资源生成一个url,语法为“$url = asset('前端资源')”。

本篇文章给大家带来了关于laravel的相关知识,其中主要介绍了关于使用中间件记录用户请求日志的相关问题,包括了创建中间件、注册中间件、记录用户访问等等内容,下面一起来看一下,希望对大家有帮助。

本篇文章给大家带来了关于laravel的相关知识,其中主要介绍了关于中间件的相关问题,包括了什么是中间件、自定义中间件等等,中间件为过滤进入应用的 HTTP 请求提供了一套便利的机制,下面一起来看一下,希望对大家有帮助。

laravel路由文件在“routes”目录里。Laravel中所有的路由文件定义在routes目录下,它里面的内容会自动被框架加载;该目录下默认有四个路由文件用于给不同的入口使用:web.php、api.php、console.php等。

在laravel中,fill方法是一个给Eloquent实例赋值属性的方法,该方法可以理解为用于过滤前端传输过来的与模型中对应的多余字段;当调用该方法时,会先去检测当前Model的状态,根据fillable数组的设置,Model会处于不同的状态。


Hot AI Tools

Undresser.AI Undress
AI-powered app for creating realistic nude photos

AI Clothes Remover
Online AI tool for removing clothes from photos.

Undress AI Tool
Undress images for free

Clothoff.io
AI clothes remover

AI Hentai Generator
Generate AI Hentai for free.

Hot Article

Hot Tools

MinGW - Minimalist GNU for Windows
This project is in the process of being migrated to osdn.net/projects/mingw, you can continue to follow us there. MinGW: A native Windows port of the GNU Compiler Collection (GCC), freely distributable import libraries and header files for building native Windows applications; includes extensions to the MSVC runtime to support C99 functionality. All MinGW software can run on 64-bit Windows platforms.

ZendStudio 13.5.1 Mac
Powerful PHP integrated development environment

VSCode Windows 64-bit Download
A free and powerful IDE editor launched by Microsoft

DVWA
Damn Vulnerable Web App (DVWA) is a PHP/MySQL web application that is very vulnerable. Its main goals are to be an aid for security professionals to test their skills and tools in a legal environment, to help web developers better understand the process of securing web applications, and to help teachers/students teach/learn in a classroom environment Web application security. The goal of DVWA is to practice some of the most common web vulnerabilities through a simple and straightforward interface, with varying degrees of difficulty. Please note that this software

mPDF
mPDF is a PHP library that can generate PDF files from UTF-8 encoded HTML. The original author, Ian Back, wrote mPDF to output PDF files "on the fly" from his website and handle different languages. It is slower than original scripts like HTML2FPDF and produces larger files when using Unicode fonts, but supports CSS styles etc. and has a lot of enhancements. Supports almost all languages, including RTL (Arabic and Hebrew) and CJK (Chinese, Japanese and Korean). Supports nested block-level elements (such as P, DIV),