Laravel の Artisan コマンドをまとめていきます。

Artisan

Artisan はコマンドラインインターフェイスで Laravel に含まれている開発に便利な機能です。
ファイルの生成だけでなく、キャッシュやマイグレーションも操作していきます。

コマンド一覧

• コマンド一覧の確認

  php artisan list

  1	php artisan list

• ヘルプ

  php artisan help コマンド名

  1	php artisan help コマンド名

• バージョン確認

  php artisan --version

  1	php artisan --version

• APP_KEY の生成

  php artisan key:generate

  1	php artisan key:generate

  .env ファイルの APP_KEY に設定します。

• Controller の生成：make:controller

  php artisan make:controller UserController php artisan make:controller Admin/UsersController

  1 2	php artisan make:controller UserController php artisan make:controller Admin/UsersController

  下記ファイルが生成されます。
  app/Http/Controllers/UserController.php
  app/Http/Controllers/Admin/UserController.php

• Requestクラスの生成：make:request

  php artisan make:request UserRequest

  1	php artisan make:request UserRequest

  下記ファイルが生成されます。
  app/Http/Requests/UserRequests.php

• モデル作成：make:model

  php artisan make:model User

  1	php artisan make:model User

  下記ファイルが生成されます。
  app/Http/Models/User.php

• モデルとマイグレーションを作成

  php artisan make:model User -m

  1	php artisan make:model User -m

• マイグレーション（テーブル作成）

  php artisan make:migration create_users_table

  1	php artisan make:migration create_users_table

• マイグレーション実行

  php artisan migrate

  1	php artisan migrate

• マイグレーションのロールバック
  最後に実行したマイグレーションのひとまとめを元に戻します。

  php artisan migrate:rollback

  1	php artisan migrate:rollback

  • マイグレーションのロールバック
    5ステップ分を戻します。

    php artisan migrate:rollback --step=5

    1	php artisan migrate:rollback --step=5

  • 全部のマイグレーションをロールバック

    php artisan migrate:reset

    1	php artisan migrate:reset

  • データベース指定

    php artisan migrate:fresh --database=mysql_test

    1	php artisan migrate:fresh --database=mysql_test

• キャッシュ生成

  • bootstrap ファイルをキャッシュ

    php artisan optimize

    1	php artisan optimize

    下記２つが実行されます。

  • 設定ファイル キャッシュ

    php artisan config:cache

    1	php artisan config:cache

    キャッシュを削除した後、bootstrap/cache/config.php が生成されます。

  • route キャッシュ
    クロージャベースのルートがあるとキャッシュできないので注意が必要です。

    php artisan route:cache

    1	php artisan route:cache

    キャッシュを削除した後、bootstrap/cache/routes.php が生成されます。

  /bootstrap/cache/packages.php も生成されます。
  /bootstrap/cache/compiled.php も生成されます。

  • view キャッシュ
    
    php artisan view:cache

    1	php artisan view:cache

    app/storage/framework/views/ 配下にキャッシュファイルが生成されます。

• キャッシュクリア

  php artisan optimize:clear

  1	php artisan optimize:clear

  以下5つのキャッシュクリアを実行します。

  • 設定ファイル キャッシュクリア

    php artisan config:clear

    1	php artisan config:clear

    bootstrap/cache/config.php が削除されます。

  • route キャッシュクリア

    php artisan route:clear

    1	php artisan route:clear

    bootstrap/cache/routes.php が削除されます。

  • アプリケーション キャッシュクリア

    php artisan cache:clear

    1	php artisan cache:clear

    storage/framework/cache/data/ 配下のキャッシュファイルが削除されます。

  • view キャッシュクリア

    php artisan view:clear

    1	php artisan view:clear

    app/storage/framework/views/ 配下のキャッシュファイルが削除されます。

  • コンパイルされたクラスファイルを削除

    php artisan clear-compiled

    1	php artisan clear-compiled

    /bootstrap/cache/services.json が削除されます。
    /bootstrap/cache/compiled.php が削除されます。

• Tinker 環境で Laravel の Eloquent ORM、ジョブ、イベントなどをコマンドラインから操作

  php artisan tinker

  1	php artisan tinker

  • DBの設定を確認する

    php artisan tinker config('database')

    1 2	php artisan tinker config('database')

  • 疑似データ生成

    php artisan tinker User(App/Models/User::class)->make()

    1 2	php artisan tinker User(App/Models/User::class)->make()

• ルートの確認

  php artisan route:list

  1	php artisan route:list

• シーダーを生成する

  php artisan make:seeder UsersTableSeeder

  1	php artisan make:seeder UsersTableSeeder

  • 指定のシーダーを実行
    事前に DatabaseSeeder.php へ登録が必要です。
    
    php artisan db:seed --class=UsersTableSeeder

    1	php artisan db:seed --class=UsersTableSeeder

• サービスプロバイダーを作成

  php artisan make:provider UserServiceProvider

  1	php artisan make:provider UserServiceProvider

• Commandクラス生成

  php artisan make:command UserCommand

  1	php artisan make:command UserCommand

  下記ファイルが生成されます。
  app/Console/Commands/UserCommand.php

• Featureテストを生成する

  php artisan make:test UserTest

  1	php artisan make:test UserTest

  下記ファイルが生成されます。
  app/tests/Feature/UserTest.php

• Unitテストを生成する

  php artisan make:test UserTest --unit

  1	php artisan make:test UserTest --unit

  下記ファイルが生成されます。
  app/tests/Unit/UserTest.php

  • Unitテスト実行
    
    vendor/bin/phpunit

    1	vendor/bin/phpunit

• Factory生成
  疑似データを定義

  php artisan make:factory UserFactory

  1	php artisan make:factory UserFactory

  • モデルを指定
    
    php artisan make:factory UserFactory --model=User

    1	php artisan make:factory UserFactory --model=User

• CLI実行

  php artisan user:show 1

  1	php artisan user:show 1

まとめ

artisan コマンドは開発にとても便利で多くの役に立つコマンドがありますので、積極的に使っていくことで開発も楽になりそうです。

参考リンク

Artisanコンソール 6.x Laravel

関連リンク

http://vistylee.com/laravel-auth/