備忘録
復習
cron
設定したスケジュールに自動でプログラムを定期的に実行するもの。
Readoubleに細かいスケジュール設定が記載されているので、ここから引用して調整する。
タイムスケジュール
流れ
Laravelでcronを使用するには crontab -e コマンドで下記を必ず追加する必要がある。
path-to-your-projectには各自のLaravelプロジェクトのpathを記載
* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1
＊は左から「分、時、日、月、曜日」。全て＊の場合は毎分実行
細かい調整は割愛
cronで実行するファイルを作成
php artisan make:controller DemoController
DemoController
class DemoController extends Controller
{
public function hoge()
{
//実行したい処理、割愛
}
}
COMMANDの作成
php artisan make:command HogeCommand
app/Console/Commands/HogeCommand
<?php
namespace App\Console\Commands;
use Illuminate\Console\Command;
use App\Http\Controllers\DemoController;
class HogeCommand extends Command
{
/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'command:-----'; //コマンド名->なんでも良い
/**
* The console command description.
*
* @var string
*/
protected $description = '------'; //コマンド説明
/**
* Create a new command instance.
*
* @return void
*/
public function __construct()
{
parent::__construct();
}
/**
* Execute the console command.
*
* @return mixed
*/
public function handle()
{
//
DemoController::hoge(); //実行するコントローラ内の処理
}
}
Kernelに追記
Kernel.phpはapp/Console/直下に初めからある。
app/Console/Kernel.php
<?php
namespace App\Console;
use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
class Kernel extends ConsoleKernel
{
/**
* The Artisan commands provided by your application.
*
* @var array
*/
protected $commands = [
\App\Console\Commands\HogeCommand::class, //追加
];
/**
* Define the application's command schedule.
*
* @param \Illuminate\Console\Scheduling\Schedule $schedule
* @return void
*/
protected function schedule(Schedule $schedule)
{
// $schedule->command('inspire')
// ->hourly();
$schedule
->command('command:-----') //コマンド名
->withoutOverlapping() //こちら多重実行を防ぐので必須らしい
->dailyAt('20:00'); //スケジュールなどの設定->公式ページ参照
}
/**
* Register the commands for the application.
*
* @return void
*/
protected function commands()
{
$this->load(__DIR__.'/Commands');
require base_path('routes/console.php');
}
}
動作確認
動作する時間まで待つのは辛いため手動でcommandを呼び出して動作確認を行う。
COMMANDの作成により追加された、command:—– があるか確認。
php artisan list //コマンドがあるか確認
↓
cache
cache:clear Flush the application cache
cache:forget Remove an item from the cache
cache:table Create a migration for the cache database table
command
command:----- --------(説明)------- //今回追加されたコマンドとその説明
登録されているコマンドを打ち込みcronの動作確認をし、エラーの確認やtestを行う。
php artisan command:----- //任意のコマンド名