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


関連記事

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

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

laravel logo

Laravelのブラウザテスト「Dusk」で非同期で重たい処理のテストを実装してみよう

1 はじめに2 JavaScriptの式で待機する2.1 テスト対象となるコード2.2 Duskのテストコード3 DOM要素の表示を待つ3.1 テスト対象となるコード3.2 Duskテストコードの実装 ...

laravel logo

Laravel SailでDocker環境構築

1 はじめに2 Laravel Sailの基本2.1 Dockerの構成2.2 コンテナの起動・停止2.3 sailで使用できるコマンド3 Laravel Sailの設定3.1 ポートフォワードの設定 ...

laravel logo

【Laravel】認証を自作して学ぶguardとmiddleware

1 はじめに1.1 認証処理の仕様2 独自の認証処理の実装2.1 Modelの実装2.2 UserProviderの実装2.3 Guardの実装2.4 Middlewareの実装2.5 Handler ...

Pythonで書かれたスクレイピングのコードをRubyで書いてみる

1 はじめに2 仕様3 ソースコード4 使用したモジュール、Gem5 対象ページを取得6 XPATHから目的のものを抜き出す7 次のページのリンクを取得する8 さいごに はじめに 以前、技術評論社さん ...

フォロー

blog-page_side_responsive

2019年5月
 1234
567891011
12131415161718
19202122232425
262728293031  

アプリ情報

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