概要
LaravelのコーディングスタイルはPHP-FIGが定めた規約のPSR-2に準拠している。
PSRにはPSR-0、PSR-1、PSR-2、PSR-4などがあり、PSR-0とPSR-4はPHPのオートローダーのための規約で、PSR-1とPSR-2は標準コーディング規約になっている。
PSRの記事ではないため規約の詳細は見やすいページのリンクを参考リンクに載せておきます。
テーブル名
記法 | 複数or単数 | 例 |
---|---|---|
スネークケース | 複数 | users item_tables |
モデル名
記法 | 複数or単数 | 例 |
---|---|---|
アッパーキャメル | 単数 | UserData ItemList |
migrationのファイル名
記法 | 複数or単数 | 例 |
---|---|---|
スネークケース | 単数 | xxx_crate_users_table xxx_add_to_items_table |
seedsのファイル名
記法 | 複数or単数 | 例 |
---|---|---|
アッパーキャメル | 指定なし | UsersTableSeeder ItemTableSeeder |
Controllersのファイル名
記法 | 複数or単数 | 例 |
---|---|---|
アッパーキャメル | 指定なし | UserDataController ItemListController |
viewsのファイル名
記法 | 複数or単数 | 例 |
---|---|---|
スネークケース | 指定なし | index users_add |
一覧
注記を省略して一覧としてまとめます。
種類 | 記法 | 複数or単数 | 例 |
---|---|---|---|
テーブル名 | スネークケース | 複数 | users_table |
モデル名 | アッパーキャメル | 単数 | UserData |
migration名 | スネークケース | 単数 | xxx_crate_users_table |
seeder名 | アッパーキャメル | --- | UsersTableSeeder |
Controllers名 | アッパーキャメル | --- | UserDataController |
views名 | スネークケース | --- | users_add |
その他の命名規則
わざわざ書き起こすような内容ではありませんが、せっかく命名規則について書き起こしたので備忘録として書きます。
laravel(PHP)では変数を$xxxと表現するため問題ないですが、他言語ではメソッド名やデータベース名と混同しないように注意する。
クラス名
記法 | 複数or単数 | 例 |
---|---|---|
アッパーキャメル | --- | UserData ItemList |
メソッド名
記法 | 複数or単数 | 例 |
---|---|---|
ローワーキャメル | --- | userData itemList |
変数名
記法 | 複数or単数 | 例 |
---|---|---|
スネークケース | --- | $user_data $item_list |
キャメルケースだとクラス名やメソッド名との混同しやすいため、変数はスネークケースで統一しています。
また、PSRで変数名に指定はないが一貫性を持たせるべきという文言はあります。
ディレクトリ名
記法 | 複数or単数 | 例 |
---|---|---|
アッパーキャメル | --- | UserData ItemList |
ファイル名
記法 | 複数or単数 | 例 |
---|---|---|
スネークケース | --- | user_data item_list |