LoginSignup
0
0

More than 3 years have passed since last update.

いい加減に「Laravelの命名規則」を覚えたいのでまとめてみた

Posted at

はじめに

こちらの記事を参考にさせていただきました!!

この記事を書こうと思った理由

  • 自分で書いてしっかりアウトプットしたかったから(1番の理由です)
  • いい加減に命名規則を覚えたかったから
  • 誤った命名規則の書き方をもうしたくなかったから
  • 今後の開発で命名規則に沿ってコーディングしていきたいから

概要

  • LaravelのコーディングスタイルはPHP-FIGが定めた規約のPSR-2に準拠している。
  • PSRにはPSR-0、PSR-1、PSR-2、PSR-4などがあり、PSR-0とPSR-4はPHPのオートローダーのための規約で、 PSR-1とPSR-2は標準コーディング規約になっている。
  • PSRの記事ではございません。
  • 万が一間違っている場所がございましたら指摘していただければ嬉しいです!!

table名

記法 複数or単数
スネークケース 複数 users
item_tables

*その他の注意点など
特記なし。

model名

記法 複数or単数
アッパーキャメル 単数 userData
itemList

*その他の注意点など
テーブル名を単数系に変換したファイル名にする。

migrationのファイル名

記法 複数or単数
スネークケース 単数 xxx_create_users_table
xxx_add_to_items_table

*その他注意点など
*「artisan make:migration ファイル名」になる。
*「xxx」には作成日時が自動的に入る。
*「add_to_xxx_table」とする事で、「xxx」がテーブル名として認識される。

seedsのファイル名

記法 複数or単数
アッパーキャメル 指定なし UsersTableSeeder
ItemTableSeeder

*その他の注意点など
ファイル名の最後を「Seeder」とする。

Controllersのファイル名

記法 複数or単数
アッパーキャメル 指定なし UserDataController
ItemListController

*その他の注意点など
ファイル名の最後を「Controller」とする。

viewsのファイル名

記法 複数or単数
スネークケース 指定なし index
users_add

*その他の注意点など
blade.phpも同様。

一覧

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

種類 記法 複数or単数
table名 スネークケース 複数 users_table
model名 アッパーキャメル 単数 UserData
migration名 スネークケース 単数 xxx_create_users_table
seeder名 アッパーキャメル --- UsersTableSeeder
Controllers名 アッパーキャメル --- UsersDataController
views名 スネークケース --- users_add

その他の命名規則

命名規則のアウトプットをしているため、備忘録として書く!!
Laravel(PHP)では変数を、$xxxと表現するため問題ないが、他言語ではメソッド名やデータベース名と混同しないように注意する。

class名

記法 複数or単数
アッパーキャメル --- UserData
ItemList

method名

記法 複数or単数
ローワーキャメル --- userData
itemList

変数名

記法 複数or単数
スネークケース --- $user_data
$item_list

※キャメルケースだとクラス名やメソッド名との混同しやすいため、変数はスネークケースで統一している。また、PSRで変数名に指定はないが一貫性を持たせるべきという文言はある。

ディレクトリ名

記法 複数or単数
アッパーキャメル --- UserData
ItemList

ファイル名

記法 複数or単数
スネークケース --- user_data
item_list
0
0
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
0
0