はじめに
命名規則って面倒くさそうですよね。しかしそれに準じればとても便利だと思います。そこをしっかり整理したいと思います。
記法名
Laravelにかぎらず、記述の仕方に名前があります。まずはそこをおさえておきます。
キャメルケース
各単語の先頭を大文字にする命名規則。見た目が凸凹していてらくだのコブのように見えることからこの名がついたそうです。覚えやすい。
アッパーキャメルケース
すべての単語の先頭を大文字にします。パスカルケースとも呼びます。
UserDataTable
ローワーキャメルケース
一番最初の単語だけは小文字にします。
userDataTable
スネークケース
単語の間をアンダーバーでつなぐ命名規則。
user_data_table
ケバブケース
単語の間をハイフンでつなぐ命名規則。
user-data-table
一般的な記述の分け方
キャメルケース ： プログラミングでの関数や変数
UserDataTableスネークケース ： DBなどで扱う値
user_data_tableケバブケース ： HTMLのclass名
user-data-table
上記のように使い分けることが多いようです。
では本題に入りましょう。
Laravelの命名規則
テーブル名
小文字の複数形にします。 リレーション先のidをカラムに収める場合は【単数名_id】とする。
| 記法 | 複数or単数 | 例 |
|---|---|---|
| スネークケース | 複数 | users items |
マイグレーションファイルを作成する際は、主にこのテーブル名に則っています。
***_create_users_table
***には作成日時が自動生成されます。
モデル名
テーブル名を単数系に変換し、先頭を大文字にします。
| 記法 | 複数or単数 | 例 |
|---|---|---|
| アッパーキャメル | 単数 | User Item |
コントローラー名
最後にControllerを付け加えます。
| 記法 | 複数or単数 | 例 |
|---|---|---|
| アッパーキャメル | 指定なし | ItemController |
一般的にはモデルごとにコントローラーを作成することも多いので、モデル「Item」を扱うコントローラーならItemControllerにすることも多いでしょう。しかし、複数のモデルを扱うコントローラーにすることもあるので、そこはプロジェクトごとに相談が必要です。
まとめ
記法
説明を省いた一覧にしています。
| 記法 | 例 | 備考 |
|---|---|---|
| アッパーキャメルケース | UserDataTable | プログラミングでの関数や変数 |
| ローワーキャメルケース | userDataTable | |
| スネークケース | user_data_table | DBなどで扱う値 |
| ケバブケース | user-data-table | HTMLのclass名 |
Laravel命名規則
| 種類 | 記法 | 複数or単数 | 例 |
|---|---|---|---|
| テーブル | スネークケース | 複数 | users items |
| モデル | アッパーキャメル | 単数 | User Item |
| コントローラー | アッパーキャメル | 指定なし | ItemController |
参考URL
命名規則「キャメルケース」「スネークケース」「ケバブケース」についてまとめてみました | 大阪市天王寺区SOHOホームページ制作 | デザインサプライ-DesignSupply.-
