【laravel+Vue】命名規則
laravelの命名規則は PHP-FIGが定めた規約のPSR-2に 準拠してます。
※PHP-FIG (The PHP Framework Interoperability Group、PHPフレームワーク相互運用グループ)
基本はartisanコマンドで生成すれば自動的に統一されますが、手動で作る事も考え一応一覧
controllerを複数名派もいますが、laravelチュートリアル等でもcontrollerは単数形なので単数派が正でしょう。
種類 | 記法 | 単数/複数 | 例 |
table | スネークケース | 複数 | users |
model | アッパーキャメル | 単数 | UserData |
migration | スネークケース | – | 作成日_crate_users_table |
seeder | アッパーキャメル | – | UsersTableSeeder |
controller | アッパーキャメル | 単数 | UserDataController |
記法について
記法名 | 記述方法 | 例 |
アッパーキャメル | 単語間を大文字で区切る、かつ頭が大文字 | UserData |
ローワーキャメル | 単語間を大文字で区切る 、かつ頭が小文字 | userData |
スネークケース | 単語間を_(アンダーバー)で区切る 蛇のしっぽ(体)みたいに連なっている事から | user_data_list |
ケバブケース | 単語間を-(ハイフン)で区切る ケバブの串にささっている様子に似ている事から | user-data-list |
データベースの命名に関しては別途下記を参照
コードの規則
種類 | 記法 | 単数/複数 | 例 |
クラス | アッパーキャメル | – | UserData |
関数 | ローワーキャメル(動詞+名詞) | – | getUserData |
変数 | スネークケース | 配列データは複数 | user_data user_datas |
定数 | 定数名はすべて大文字のスネークケース | – | USER_ROLE |
ディレクトリ | アッパーキャメル | – | User |
ファイル | アッパーキャメル | – | Show.vue |
URL | ケバブケース | – | user-list |
コーディングチェックツール
PHP_CodeSnifffer等でコードが統一されているかチェックできるようです。