Hi dev,

A laravel enum attribute casting example is the major focus of today. Using this example, you can learn how to use enum in Laravel. If you're looking for a Laravel example of how to use enums, you've come to the correct spot. Here you may find out more about laravel enum cast. Follow the instructions below to use the Laravel model cast enum.

You can build a migration, take the enum data type, and set an enum value there if you wish to use the enum data type for your table. However, you must construct a new migration and make the necessary changes if you decide to add more enum values in the future. Therefore, enum model attribute casting is introduced in Laravel 9. You can set cast on the model and generate an enum class. You can see the below step by step example and learn from there.

In this example, first, we will create migration with string column "status" and default value will be "pending". Then we will create a model with a casting to set enum class. Then we will create enum class with specific values and use on model cast. so let's see simple example and learn it.

This is optional; however, if you have not created the laravel app, then you may go ahead and execute the below command:

composer create-project laravel/laravel example-app	

Here, we need create database migration for "products" table with name, body and status columns and also we will create model for products table.

php artisan make:migration create_products_table	

<?php
  
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
  
return new class extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('products', function (Blueprint $table) {
            $table->id();
            $table->string('name');
            $table->text('body');
            $table->string('status')->default('pending');
            $table->timestamps();
        });
    }
  
    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('products');
    }
};	

Then run migration command to create items table.

php artisan migrate	

In this step, we will create ProductStatusEnum.php class and define all enum values. let's create model and update following code:

<?php
  
namespace App\Enums;
 
enum ProductStatusEnum:string {
    case Pending = 'pending';
    case Active = 'active';
    case Inactive = 'inactive';
    case Rejected = 'rejected';
}	

In this step, we will create Product.php model with cssting. let's create model and update following code:

php artisan make:model Product	

<?php
  
namespace App\Models;
  
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use App\Enums\ProductStatusEnum;
  
class Product extends Model
{
    use HasFactory;
  
    /**
     * Write code on Method
     *
     * @return response()
     */
    protected $fillable = [
        'name', 'body', 'status'
    ];
  
    /**
     * Write code on Method
     *
     * @return response()
     */
    protected $casts = [
        'status' => ProductStatusEnum::class
    ];
}	

In third step, we will create one route for testing. so create one route here.

<?php
 
use Illuminate\Support\Facades\Route;
use App\Http\Controllers\ProductController;
   
/*
|--------------------------------------------------------------------------
| Web Routes
|--------------------------------------------------------------------------
|
| Here is where you can register web routes for your application. These
| routes are loaded by the RouteServiceProvider within a group which
| contains the "web" middleware group. Now create something great!
|
*/
     
Route::get('product-test', [ProductController::class, 'index']);	

In this step, we will create ProductController file and write index() method to create item records with array and access as array.

<?php
  
namespace App\Http\Controllers;
  
use Illuminate\Http\Request;
use App\Models\Product;
  
class ProductController extends Controller
{
    /**
     * Write code on Method
     *
     * @return response()
     */
    public function index()
    {
        $input = [
            'name' => 'Gold',
            'body' => 'This is a Gold',
            'status' => ProductStatusEnum::Active
        ];
  
        $product = Product::create($input);
  
        dd($product->status, $product->status->value);
  
    }
}	

All the required steps have been done, now you have to type the given below command and hit enter to run the Laravel app:

php artisan serve	

Now, Go to your web browser, type the given URL and view the app output:

http://localhost:8000/product-test	

App\Enums\ProductStatusEnum {#1250 

  name: "Active"

  value: "active"

}

active	

I hope it can help you...