はじめに

Laravelには、コントローラー、モデル、ビューなどの要素があり、それぞれに命名規則があります。また、Laravelはコーディング規約のPSR-1やコーディングスタイルのPSR-2に基づいた命名規則を採用しています。この記事では、Laravelの命名規則についてまとめていきます。

Laravelの命名基本ルール

コントローラーは、クラスで実装されます。コントローラーのクラス名は、以下のルールに従う必要があります。

また、一般的にコントローラー名には、アプリケーションのドメイン知識に関する単語を使用することが推奨されます。例えば、ECサイトの場合はProductControllerやCartControllerなどが該当します。

ProductController.php

class ProductController extends Controller
{
    //
}

モデルは、データベースとのやりとりを担当するクラスです。モデルのクラス名は、以下のルールに従う必要があります。

また、モデル名はテーブル名と一致するようにすることが推奨されます。例えば、product_namesテーブルに対応するモデルの場合はProductNameといった具合です。

ProductName.php

class ProductName extends Model
{
    //
}

リレーションは種類に応じて、適切な記述方法を行います。例えば、belongsToリレーションであれば、メソッド名を単数形のモデル名として定義します。

Product.php

public function user(): BelongsTo
{
    return $this->belongsTo(User::class);
}

また、hasManyリレーションであれば、posts()のようにメソッド名を複数形のモデル名として定義します。

User.php

public function products(): HasMany
{
    return $this->hasMany(Product::class);
}

マイグレーションファイルは、データベースのテーブル構造を定義するためのファイルです。マイグレーションファイルのファイル名は、以下のルールに従う必要があります。

例えば、「users」というテーブルを作成する場合は、以下のようにファイル名を記述します。

xxx_create_users_table.php

ビューは、HTMLなどの表示用のファイルです。ビューのファイル名は、以下のルールに従う必要があります。

また、コントローラーと対応するビューの場合は、コントローラー名に対応したビュー名にすることが一般的です。例えば、UserControllerに対応するビューの場合はuser.blade.phpと命名します。

resources/
        views/
            user/
                user.blade.php

ルーティングは、URLとコントローラーのアクションを紐付けるための設定です。ルーティングの名前は、以下のルールに従う必要があります。

例えば、「Product」というコントローラーの「index」アクションに対応するルートがある場合は、以下のようにルートの名前を記述します。

web.php

Route::get('products', [ProductController::class, 'index'])->name('product_name.index');

Laravelには、コントローラー、モデル、マイグレーションファイル、ビュー、ルーティングなど、様々な要素があります。命名規則は、プロジェクトのメンテナンス性や拡張性を高めるための重要な要素の1つですので、参考になれば幸いです。