BackEnd

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

投稿日:2019年5月30日 更新日:

はじめに

こんにちは。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コマンドでさくっとインストール完了です。

enumクラス

生成

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

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

enumクラス編集

日本語化

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

マイグレーション

生成

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

編集

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

プロパティのキャスト

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

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

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

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

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

さいごに

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

おすすめ書籍

PHPフレームワーク Laravel Webアプリケーション開発 バージョン5.5 LTS対応 PHPフレームワーク Laravel入門

blog-page_footer_336




blog-page_footer_336




-BackEnd
-, ,

執筆者:


comment

メールアドレスが公開されることはありません。

CAPTCHA


関連記事

laravel logo

[Laravel] ログの扱い方 [5.8]

1 はじめに2 環境3 Monologについて4 コード上で設定する方法5 config/logging.phpで設定する方法6 おまけ:ログレベルについて7 さいごに8 おすすめ書籍 はじめに こん ...

rails

form_withでフォームの送信前に処理を行う方法

1 はじめに2 form_with3 サンプル4 さいごに5 参考 はじめに フォームを送信する前に処理を行いたいケース(Google Analyticsのイベントのトラッキングなど)があると思います ...

rails

RailsでS3に画像をアップロードする

1 はじめに2 今回やりたいこと3 下準備3.1 ImageMagickをインストールする3.2 Gemをインストールする4 レコード生成時にファイルを指定してアップロードする4.1 アップローダを作 ...

markdownで書けるドキュメントツールのGitbookを試す

1 はじめに2 Gitbookとは3 nvm4 node.jsインストール5 Gitbook導入5.1 インストール5.2 初期化5.3 ローカルでブラウザから確認6 作成と編集6.1 見出し編集7 ...

PHPerだけどKotlinを勉強したって良いよね その1〜クラス編〜

1 はじめに2 インターフェース2.1 基本2.2 デフォルト実装付メソッド2.3 同じメソッド名を持つ複数のインターフェース3 修飾子3.1 open3.2 abstract4 可視性修飾子5 さい ...

フォロー

follow us in feedly

blog-page_side_responsive

2019年5月
 1234
567891011
12131415161718
19202122232425
262728293031 

アプリ情報

私たちは無料アプリもリリースしています、ぜひご覧ください。 下記のアイコンから無料でダウンロードできます。