laravel-enumを使ってみたら快適だった

1 はじめに
2 enumについて
3 環境
4 導入
5 enumクラス
6 マイグレーション
- 6.1 生成
- 6.2 編集
7 プロパティのキャスト
8 さいごに
9 おすすめ書籍

はじめに

こんにちは。Laravelでenumを使いたい時、PHPやLaravel本体ではサポートされていないのでComposer経由でパッケージを入れることになります。
今はbensampo/laravel-enumを使っており、とりあえず不自由ない感じなので、紹介しようと思います。

enumについて

列挙型 – Wikipedia

railsで初めてenumを知ったのですが、C言語の時点で既にあったのですね。
私は「限られた値しか持てないデータ型」と認識してます。

例えば注文情報テーブルに支払方法を保存する時、データベースのordersテーブルにpayment_typeカラムを持たせるとします。
card, transfer, cashなど支払方法名だけがorders.payment_typeに入るようにしつつ、表示時は「クレジットカード」や「銀行振込」といった文字列で扱いたい…なんてケースはよくあると思いますが、こういう場合に便利です。

環境

PHP 7.3.3
Laravel 5.8
laravel-enum　1.9

導入

composerコマンドでさくっとインストール完了です。

$ composer require bensampo/laravel-enum

Using version ^1.19 for bensampo/laravel-enum
./composer.json has been created
Loading composer repositories with package information
...
...
...
Writing lock file
Generating autoload files

$ composer require bensampo/laravel-enum

Using version ^1.19 for bensampo/laravel-enum

./composer.json has been created

Loading composer repositories with package information

...

Writing lock file

Generating autoload files

enumクラス

生成

マイグレーションはenumクラスの後に作った方が（多分）効率が良いので、まずはenumクラスを生成します。

$ php artisan make:enum PaymentType
Enum created successfully.

1 2	$ php artisan make:enum PaymentType Enum created successfully.

なおデフォルトではapp/Enumsディレクトリが生成され、その中にPHPファイルが自動生成されます。ディレクトリを切り分けたい場合、例えばapp/Enums/Orderに作りたいのであればOrder/PaymentTypeとなります。
このパラメータ、app/Enumsを起点とした相対パスとして扱われるので、例えば$ php artisan make:enum ../Models/Enums/TestEnumと記述すれば、app/Models/EnumsTestEnum.phpが生成されます。
ディレクトリ構造はプロジェクトによって様々だと思いますので、お好みで。

enumクラス編集

<?php
// app/Enums/PaymentType.php
namespace App\Enums;

use BenSampo\Enum\Contracts\LocalizedEnum;
use BenSampo\Enum\Enum;

final class PaymentType extends Enum implements LocalizedEnum
{
    const CREDIT_CARD = 'credit_card';
    const TRANSFER = 'transfer';
    const CASH = 'cash';
}

<?php

// app/Enums/PaymentType.php

namespace App\Enums;

use BenSampo\Enum\Contracts\LocalizedEnum;

use BenSampo\Enum\Enum;

final class PaymentType extends Enum implements LocalizedEnum

{

const CREDIT_CARD = 'credit_card';

const TRANSFER = 'transfer';

const CASH = 'cash';

}

日本語化

続いて公式の方法に従ってresources/lang/ja/enums.phpを作成し、以下のように記述します。フレームワークのlocale設定に従ったenums.phpを読みに行きますので、config/app.phpのlocaleを日本（ja）に設定しておきましょう。

<?php
// config/app.php
return [
    // 中略

    'locale' => 'ja',

    // 中略
];

<?php

// config/app.php

return [

// 中略

'locale' => 'ja',

// 中略

];

<?php
// resources/lang/ja/enums.php
use App\Enums\PaymentType;

return [
    PaymentType::class => [
        PaymentType::CREDIT_CARD => 'クレジットカード',
        PaymentType::TRANSFER => '銀行振込',
        PaymentType::CASH => '現金',
    ],
];

<?php

// resources/lang/ja/enums.php

use App\Enums\PaymentType;

return [

PaymentType::class => [

PaymentType::CREDIT_CARD => 'クレジットカード',

PaymentType::TRANSFER => '銀行振込',

PaymentType::CASH => '現金',

];

マイグレーション

生成

ordersテーブルにpayment_typeというenum型のカラムを追加します。

$ php artisan make:migration add_column_payment_type --table=orders
Created Migration: 2019_05_**_******_add_column_payment_type

1 2	$ php artisan make:migration add_column_payment_type --table=orders Created Migration: 2019_05__****_add_column_payment_type

編集

$table->enum()はLaravel 5.8から使用できます。直接指定できるのはいいですね。
また「マイグレーションはクラス作成の後で」と前述したのは、enum型カラムの定義にenumクラスの値を適用できるためです。もちろん配列をべた書きしてもいいのですが、この方がすっきり分かりやすいかなと。

<?php
// database/migrations/2019_05_**_******_add_column_payment_type.php
use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
use App\Enums\PaymentType;

class AddColumnPaymentType extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::table('orders', function (Blueprint $table) {
            $table->enum('payment_type', PaymentType::getValues())
                ->default(PaymentType::CREDIT_CARD)
                ->after('id');
        });
    }
}

<?php

// database/migrations/2019_05_**_******_add_column_payment_type.php

use Illuminate\Support\Facades\Schema;

use Illuminate\Database\Schema\Blueprint;

use Illuminate\Database\Migrations\Migration;

use App\Enums\PaymentType;

class AddColumnPaymentType extends Migration

{

/**

* Run the migrations.

* @return void

public function up()

{

Schema::table('orders', function (Blueprint $table) {

$table->enum('payment_type', PaymentType::getValues())

->default(PaymentType::CREDIT_CARD)

->after('id');

});

}

プロパティのキャスト

Eloquentではモデルクラスのプロパティに定義することで、インスタンス生成時に別の型に自動キャストしてくれる機能があります。protected $dates = [];に入れておけば自動でCarbonにキャストしてくれるとか、そういうやつです。
laravel-enumでも同様の機能があり、以下のコードで自動キャストが可能です。

<?php

namespace App;

use App\Enums\PaymentType;
use Illuminate\Database\Eloquent\Model;

class Order extends Model
{
    protected $dates = [
        'created_at',
        'updated_at'
    ];

    protected $enumCasts = [
        'payment_type' => PaymentType::class,
    ];
}

<?php

namespace App;

use App\Enums\PaymentType;

use Illuminate\Database\Eloquent\Model;

class Order extends Model

{

protected $dates = [

'created_at',

'updated_at'

];

protected $enumCasts = [

'payment_type' => PaymentType::class,

];

}

こうしておくことで何が嬉しいのかと言うと、以下のようにbladeでの記述が減ります。

// 自動キャストしない場合
<span>{{PaymentType::getDescription($order->payment_type)}}</span>

// 自動キャストする場合
<span>{{$order->payment_type->description}}</span>

// 自動キャストしない場合

<span>{{PaymentType::getDescription($order->payment_type)}}</span>

// 自動キャストする場合

<span>{{$order->payment_type->description}}</span>

当初は自動キャストせず前者のように書いてたのですが

「いちいちstaticメソッド呼ぶのかったるいよね？」
「ていうかbladeでこの書き方はイマイチなのでは？」
「何かもっとスマートな書き方ないの？あるよね？」

と思い至り、調べた結果見つけた方法でした。
地味ですが少しでもコード量は減らしたいので！

さいごに

enum、いいですね。昔はこういった実装をする際、DBにマスターテーブル作ってconst.phpとか作って定数を列挙して…みたいなことをしてましたが、大抵const.phpが肥大化して管理が億劫になってました。定義がコード化されて気分がいいです。

日	月	火	水	木	金	土
			1	2	3	4
5	6	7	8	9	10	11
12	13	14	15	16	17	18
19	20	21	22	23	24	25
26	27	28	29	30	31

laravel-enumを使ってみたら快適だった

はじめに

enumについて

環境

導入

enumクラス

生成

enumクラス編集

日本語化

マイグレーション

生成

編集

プロパティのキャスト

さいごに

おすすめ書籍

フォロー

アプリ情報