LravelのModelをapp/Modelsへ配置する方法【ディレクトリ構造変更】

LaravelのデフォルトではモデルファイルはAppディレクトリ以下に配置されます。しかし、ファイルの数が多くなることも考えてモデル用のディレクトリに入れたい場合があります。
この記事では「LravelのModelをapp/Models以下にする配置する方法」を解説しています。変更する手順を他への影響、makeコマンドでの注意点などについても紹介！

Contents

Lravelのディレクトリ構造

appディレクトリ以下

Laravelのデフォルトではモデルファイルが「app」ディレクトリの中にあります。

app
- Console
- Exceptions
- Http
- Providers
- User.php

モデルファイルが多くなるとappの他のディレクトリと並んでゴチャゴチャしてしまいます。
そのためモデルファイルはモデルのみのディレクトリに入れるよう変更します。

途中で変更する場合の影響

途中でモデルファイルをディレクトに移動させたい場合には、既存でモデルクラスを読み込んでいる場所を書き換える必要が出てきます。数が多くなると結構手間なのでプロジェクト作成後など早いタイミングでディレクトリ構造を変更できるといいでしょう。
プロジェクト作成直後でもUserモデルを認証のconfigやユーザー登録などの処理で使っているため変更が必要にはなります。

Modelのディレクトリ構造を変える手順

ディレクトリを新たに作成して移動

まずは「app/Models」を作成します。
そして最初からある「User.php」を移動しましょう。

$ mkdir app/Models
$ mv app/User.php app/Models/

1 2	$ mkdir app/Models $ mv app/User.php app/Models/

app
- Console
- Exceptions
- Http
- Providers
- Models
  - User.php

上記のようになります。

User.phpを編集

「User.php」のnamespaceを「App」から「App\Models」に変更しましょう。

<?php

namespace App\Models;

use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{

<?php

namespace App\Models;

use Illuminate\Contracts\Auth\MustVerifyEmail;

use Illuminate\Foundation\Auth\User as Authenticatable;

use Illuminate\Notifications\Notifiable;

class User extends Authenticatable

{

途中でディレクトリ構造を変える場合などで他にもモデルクラスがある場合には同じように変更しましょう。

configファイルを編集

「User.php」の変更で影響するconfigファイルを編集します。
下記2ファイルが対象になります。

config/auth.php
config/services.php

Laravel6.0以降は「config/services.php」の編集は不要になってました。

「App\User::class」を「App\Models\User::class」に変えます。

config/auth.php

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | Authentication Defaults
    |--------------------------------------------------------------------------
    |
    | This option controls the default authentication "guard" and password
    | reset options for your application. You may change these defaults
    | as required, but they're a perfect start for most applications.
    |
    */

    'defaults' => [
        'guard' => 'web',
        'passwords' => 'users',
    ],

    /*
    |--------------------------------------------------------------------------
    | Authentication Guards
    |--------------------------------------------------------------------------
    |
    | Next, you may define every authentication guard for your application.
    | Of course, a great default configuration has been defined for you
    | here which uses session storage and the Eloquent user provider.
    |
    | All authentication drivers have a user provider. This defines how the
    | users are actually retrieved out of your database or other storage
    | mechanisms used by this application to persist your user's data.
    |
    | Supported: "session", "token"
    |
    */

    'guards' => [
        'web' => [
            'driver' => 'session',
            'provider' => 'users',
        ],

        'api' => [
            'driver' => 'token',
            'provider' => 'users',
            'hash' => false,
        ],
    ],

    /*
    |--------------------------------------------------------------------------
    | User Providers
    |--------------------------------------------------------------------------
    |
    | All authentication drivers have a user provider. This defines how the
    | users are actually retrieved out of your database or other storage
    | mechanisms used by this application to persist your user's data.
    |
    | If you have multiple user tables or models you may configure multiple
    | sources which represent each model / table. These sources may then
    | be assigned to any extra authentication guards you have defined.
    |
    | Supported: "database", "eloquent"
    |
    */

    'providers' => [
        'users' => [
            'driver' => 'eloquent',
            'model' => App\Models\User::class,
        ],

        // 'users' => [
        //     'driver' => 'database',
        //     'table' => 'users',
        // ],
    ],

    /*
    |--------------------------------------------------------------------------
    | Resetting Passwords
    |--------------------------------------------------------------------------
    |
    | You may specify multiple password reset configurations if you have more
    | than one user table or model in the application and you want to have
    | separate password reset settings based on the specific user types.
    |
    | The expire time is the number of minutes that the reset token should be
    | considered valid. This security feature keeps tokens short-lived so
    | they have less time to be guessed. You may change this as needed.
    |
    */

    'passwords' => [
        'users' => [
            'provider' => 'users',
            'table' => 'password_resets',
            'expire' => 60,
        ],
    ],

];

'providers' => [

'users' => [

'driver' => 'eloquent',

'model' => App\Models\User::class,

// 'users' => [

// 'driver' => 'database',

// 'table' => 'users',

// ],

config/services.php

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | Third Party Services
    |--------------------------------------------------------------------------
    |
    | This file is for storing the credentials for third party services such
    | as Stripe, Mailgun, SparkPost and others. This file provides a sane
    | default location for this type of information, allowing packages
    | to have a conventional place to find your various credentials.
    |
    */

    'mailgun' => [
        'domain' => env('MAILGUN_DOMAIN'),
        'secret' => env('MAILGUN_SECRET'),
        'endpoint' => env('MAILGUN_ENDPOINT', 'api.mailgun.net'),
    ],

    'postmark' => [
        'token' => env('POSTMARK_TOKEN'),
    ],

    'ses' => [
        'key' => env('AWS_ACCESS_KEY_ID'),
        'secret' => env('AWS_SECRET_ACCESS_KEY'),
        'region' => env('AWS_SES_REGION', env('AWS_DEFAULT_REGION', 'us-east-1')),
    ],

    'sparkpost' => [
        'secret' => env('SPARKPOST_SECRET'),
    ],

    'stripe' => [
        'model' => App\Models\User::class,
        'key' => env('STRIPE_KEY'),
        'secret' => env('STRIPE_SECRET'),
        'webhook' => [
            'secret' => env('STRIPE_WEBHOOK_SECRET'),
            'tolerance' => env('STRIPE_WEBHOOK_TOLERANCE', 300),
        ],
    ],

];

'stripe' => [

'model' => App\Models\User::class,

'key' => env('STRIPE_KEY'),

'secret' => env('STRIPE_SECRET'),

'webhook' => [

'secret' => env('STRIPE_WEBHOOK_SECRET'),

'tolerance' => env('STRIPE_WEBHOOK_TOLERANCE', 300),

makeコマンドでの指定

通常通りにmake:modelを行うとapp以下モデルが作られてしまいます。

$ php artisan make:model Models/ModelName

1	$ php artisan make:model Models/ModelName

「Models/」をつけることで「app/Models」に作成されます。

まとめ

デフォルトではモデルクラスはappディレクトリにありますが、「app/Models」をつくるなどして自由にディレクトリ構造を変えることができます。後から変更すると変更箇所が増えるので、プロジェクト開始時考えておくといいでしょう。
以上、LravelのModelをapp/Modelsへ配置する方法でした！

LravelのModelをapp/Modelsへ配置する方法【ディレクトリ構造変更】

Lravelのディレクトリ構造

appディレクトリ以下

途中で変更する場合の影響

Modelのディレクトリ構造を変える手順

ディレクトリを新たに作成して移動

User.phpを編集

configファイルを編集

config/auth.php

config/services.php

makeコマンドでの指定

まとめ

この記事を書いた人

関連記事

Laravelのパスワードリセットメールをオリジナルの文章・デザインにする方法

LaravelのMigrationでカラム変更でのエラー原因と解決方法

Composerでメモリエラーが出る時の対処方法

phpMyAdminで「Warning in ./libraries/sql.lib.php#613」というエラーが出たときの対処方法

WordPressで「Warning: count()」が出る場合の原因と対処方法

Laravelのインストール方法。新規プロジェクト作成の流れを解説！