205
202

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 3 years have passed since last update.

【laravel】laravelの命名規則

Last updated at Posted at 2020-04-02

概要

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
*その他注意点など 「artisan make:migraton ファイル名」になる。 「xxx」には作成日時が自動で入る。 「add_to_xxx_table」とすることでxxxがテーブル名として認識される。

seedsのファイル名

記法 複数or単数
アッパーキャメル 指定なし UsersTableSeeder
ItemTableSeeder
*その他注意点など ファイル名の最後を「Seeder」とする。

Controllersのファイル名

記法 複数or単数
アッパーキャメル 指定なし UserDataController
ItemListController
*その他注意点など ファイル名の最後を「Controller」とする。

viewsのファイル名

記法 複数or単数
スネークケース 指定なし index
users_add
*その他注意点など blade.phpも同様。

一覧

注記を省略して一覧としてまとめます。

種類 記法 複数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

#参考
Laravel学習帳
Rito Labo
Sider Blog

205
202
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
205
202

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?