Hapicode

# Laravel schedule 設定

Laravel タスクスケジュールは cron タスクの定期実行する作業を楽にしてくれる便利機能です。
app/Console/Kernel.php ファイルの schedule メソッド定義することでサーバ上でスケジュールするタスクを管理できるようになります。

スケジューラの実行

一行を cron に登録するだけで今までコマンドが増やす度に crontab を編集することなくります。

* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1

# スケジュールオプション

メソッド 説明
->cron('* * * * *'); カスタム cron スケジュールでタスクを実行
->everyMinute(); 毎分タスク実行
->everyTwoMinutes(); ２分毎にタスク実行
->everyThreeMinutes(); ３分毎にタスク実行
->everyFourMinutes(); ４分毎にタスク実行
->everyFiveMinutes(); ５分毎にタスク実行
->everyTenMinutes(); １０分毎にタスク実行
->everyFifteenMinutes(); １５分毎にタスク実行
->everyThirtyMinutes(); ３０分毎にタスク実行
->hourly(); 毎時タスク実行
->hourlyAt(17); １時間ごと、毎時１７分にタスク実行
->everyTwoHours(); ２時間毎にタスク実行
->everyThreeHours(); ３時間毎にタスク実行
->everyFourHours(); ４時間毎にタスク実行
->everySixHours(); ６時間毎にタスク実行
->daily(); 毎日深夜１２時に実行
->dailyAt('13:00'); 毎日 13:00 に実行
->twiceDaily(1, 13); 毎日 1:00 と 13:00 時に実行
->weekly(); 毎週日曜日の 00:00 にタスク実行
->weeklyOn(1, '8:00'); 毎週月曜日の 8:00 時に実行
->monthly(); 毎月１日の 00:00 にタスク実行
->monthlyOn(4, '15:00'); 毎月 4 日の 15:00 に実行
->twiceMonthly(1, 16, '13:00'); 毎月１日と１６日の 13:00 にタスク実行
->lastDayOfMonth('15:00'); 毎月最終日の 15:00 時に実行
->quarterly(); 四半期の初日の 00:00 にタスク実行
->yearly(); 毎年１月１日の 00:00 にタスク実行
->yearlyOn(6, 1, '17:00'); 毎年６月１日の 17:00 にタスク実行
->timezone('Asia/Tokyo'); タスクのタイムゾーンを設定

追加のスケジュール制約のリスト

メソッド 説明
->weekdays(); ウィークデーのみに限定
->weekends(); ウィークエンドのみに限定
->sundays(); 日曜だけに限定
->mondays(); 月曜だけに限定
->tuesdays(); 火曜だけに限定
->wednesdays(); 水曜だけに限定
->thursdays(); 木曜だけに限定
->fridays(); 金曜だけに限定
->saturdays(); 土曜だけに限定
->days(array|mixed); 特定の日にちだけに限定[0,1,2,3,4,5,6]日月火水木金土
->between($startTime, $endTime); 開始と終了時間間にタスク実行を制限
->unlessBetween($startTime, $endTime); 開始と終了時間間にタスクを実行しないよう制限
->when(Closure); クロージャの戻り値が true の時のみに限定
->environments($env); 指定の環境でのみタスク実行を限定

# when 論理テスト制約

特定の論理テストの結果に基づいてタスクの実行を制限するメソッドで
指定したクロージャが true を返す場合、他の制約が実行を停止しない限りタスクを実行されます
when() をいくつかチェーンした場合、全部の when 条件が true を返すときのみスケジュールされたコマンドが実行されます

$schedule->command('emails:send')->daily()->when(function () {
    return true;
});

# 環境制約

environments メソッドは、指定する環境でのみタスクを実行

$schedule->command('emails:send')
            ->daily()
            ->environments(['staging', 'production']);

# タイムゾーン設定

laravel スケジュール管理のデフォルトタイムゾーンがUTCです。

一つのコマンドに対し、timezone オプションメソッド使います。

$schedule->command('report:generate')
         ->timezone('Asia/Tokyo')
         ->at('1:00')

App\Console\Kernel.php ファイルに scheduleTimezone ファンクション追加することで、管理されるすべてのスケジュールに対応

    protected function scheduleTimezone()
    {
        return 'Asia/Tokyo';
    }

# タイムゾーン一覧

タイムゾーン一覧

タイムゾーン ID タイムゾーン名称 UTC との時差（単位：時間）
Africa/Johannesburg 南アフリカ標準時間 2
Africa/Lagos 西アフリカ時間 1
Africa/Windhoek 西アフリカ時間 1
America/Adak ハワイ - アリューシャン標準時間 -10
America/Anchorage アラスカ標準時間 -9
America/Argentina/Buenos_Aires アルゼンチン時間 -3
America/Bogota コロンビア時間 -5
America/Caracas ベネズエラ時間 -4.5
America/Chicago 中部標準時間 -6
America/Denver 山地標準時間 -7
America/Godthab 西グリーンランド時間 -3
America/Guatemala 中部標準時間 -6
America/Halifax 大西洋標準時間 -4
America/Los_Angeles 太平洋標準時間 -8
America/Montevideo ウルグアイ時間 -3
America/New_York 東部標準時間 -5
America/Noronha フェルナンド・デ・ノローニャ時間 -2
America/Phoenix 山地標準時間 -7
America/Santiago チリ時間 -4
America/Santo_Domingo 大西洋標準時間 -4
America/St_Johns ニューファンドランド標準時間 -3.5
Asia/Baghdad アラビア標準時間 3
Asia/Baku アゼルバイジャン時間 4
Asia/Beirut 東ヨーロッパ時間 2
Asia/Dhaka バングラデシュ時間 6
Asia/Dubai 湾岸標準時間 4
Asia/Irkutsk イルクーツク時間 9
Asia/Jakarta 西インドネシア時間 7
Asia/Kabul アフガニスタン時間 4.5
Asia/Kamchatka ペトロパブロフスクカムチャツキー時間 12
Asia/Karachi パキスタン時間 5
Asia/Kathmandu ネパール時間 5.75
Asia/Kolkata インド標準時間 5.5
Asia/Krasnoyarsk クラスノヤルスク時間 8
Asia/Omsk オムスク時間 7
Asia/Rangoon ミャンマー時間 6.5
Asia/Shanghai 中国標準時間 8
Asia/Tehran イラン標準時間 3.5
Asia/Tokyo 日本標準時間 9
Asia/Vladivostok ウラジオストク時間 11
Asia/Yakutsk ヤクーツク時間 10
Asia/Yekaterinburg エカテリンブルグ時間 6
Atlantic/Azores アゾレス時間 -1
Atlantic/Cape_Verde カーボベルデ時間 -1
Australia/Adelaide 中部標準時間（南オーストラリア） 9.5
Australia/Brisbane 東部標準時間（クイーンズランド） 10
Australia/Darwin 中部標準時間（ノーザンテリトリー） 9.5
Australia/Eucla 中西部標準時間（オーストラリア） 8.75
Australia/Lord_Howe ロードハウ島標準時間 10.5
Australia/Sydney 東部標準時間（ニューサウスウェールズ） 10
Etc/GMT+12 GMT-12:00 -12
Europe/Berlin 中部ヨーロッパ時間 1
Europe/London グリニッジ標準時間 0
Europe/Moscow モスクワ標準時間 4
Pacific/Apia 西サモア時間 13
Pacific/Auckland ニュージーランド標準時間 12
Pacific/Chatham チャタム標準時間 12.75
Pacific/Easter イースター島時間 -6
Pacific/Gambier ガンビア時間 -9
Pacific/Honolulu ハワイ標準時間 -10
Pacific/Kiritimati ライン諸島時間 14
Pacific/Majuro マーシャル島時間 12
Pacific/Marquesas マルケサス時間 -9.5
Pacific/Norfolk ノーフォーク時間 11.5
Pacific/Noumea ニューカレドニア時間 11
Pacific/Pago_Pago サモア標準時間 -11
Pacific/Pitcairn ピトケルン島標準時間 -8
Pacific/Tongatapu トンガ時間 13
UTC 協定世界時間 0

# タスク出力

予定通りにタスクが動いてるかどうか後から調べるときに重宝するメソッドです。

ファイルへ出力

$schedule->command('emails:send')
         ->daily()
         ->sendOutputTo($filePath);

$schedule->command('emails:send')
         ->daily()
         ->appendOutputTo($filePath);

sendOutputTo メソッドはファイル名を指定しただけでとファイルの上書きを行うので、ファイルに追記していきたい場合は sendOutputTo の第 2 引数を true に設定するか appendOutputTo メソッドを利用してください。

# 指定のメールアドレスへ出力

$schedule->command('report:generate')
         ->daily()
         ->sendOutputTo($filePath)
         ->emailOutputTo('taylor@example.com');

// ゼロ以外の終了コードで終了した場合にのみ出力
$schedule->command('report:generate')
         ->daily()
         ->emailOutputOnFailure('taylor@example.com');

# タスクフック

before after メソッド

$schedule->command('emails:send')
         ->daily()
         ->before(function () {
             // タスクが実行されようとしている
         })
         ->after(function () {
             // タスクが実行された
         });

onSuccess onFailure メソッド

$schedule->command('emails:send')
         ->daily()
         ->onSuccess(function (Stringable $output) {
             // タスク成功時…
         })
         ->onFailure(function (Stringable $output) {
             // タスク失敗時…
         });

コマンドから出力を利用できる場合は、フックのクロージャの定義で$output 引数として Illuminate\Support\Stringable インスタンスを型指定することで、after、onSuccess、または onFailure フックでアクセスできます。

# URL への Ping

タスクの実行前または実行後に、指定する URL に自動的に ping を実行

$schedule->command('emails:send')
         ->daily()
         ->pingBefore($url)
         ->thenPing($url);

$schedule->command('emails:send')
         ->daily()
         ->pingOnSuccess($successUrl)
         ->pingOnFailure($failureUrl);
2021-12-01
  • php
  • laravel

関連記事

Laravel メンテナンスモード

Laravelのメンテナンスモードの使い方 Artisan down コマンド使ってメンテナンスモー...

Laravel model で hidden に設定したカラムを一時解除

Laravel モデルにhiddenで非表示になったカラムを一時的に表示するように変更しました。...

Laravel でカテゴリー作成 テーブル構築と再帰クエリ

カテゴリ関係を管理するためのテーブルを設計...

Laravel Queue で非同期処理

Queue処理のメリットとLaravel Queue使って一括処理の例をまとめ...

Laravel notification メール通知カスタマイズ

Laravelの通知（Notification）機能を使ってメール送信する作業があったので、まとめま...

Laravel lang バリデーションメッセージを多言語対応

Laravelバリデーションのエラーメッセージを多言語で対応する手順を紹介...

Laravel を API サーバーとしての初期設定

Laravel インストールからローカル環境のSail docker開発、初期設定までプロジェクト構...

Laravel リクエストログ出力

Laravelでリクエストログを出力する手順をまとめました。...

Carbon で php date 日付の日数・月数差を計算

Laravel Carbonは、DateTimeクラスよりもシンプルで読みやすいコードを書くことがで...

Laravel 429 Too Many Requests

Laravel 19使ってAPIサーバー構築とフロントはReact nextjsで構築しています。複...

Laravel Email バリデーションについて

Laravel Validation Email チェックする際の注意点、バリデーションルールオプシ...

Laravel Sanctum 使って API トークン JWT 認証と SPA 認証

Laravel JWT APIトークンの仕組みと Laravel Sanctum SPA認証使って認...

AWS SES メール開封確認　 DB に集計

メール送信の開封確認して DB更新するために使う AWS サービス SES SNS LAMBDA と...

Laravel logger でエラーログを chatwork に自動送信

Laravel 使ってエラー発生した場合、chatworkにエラー内容をリアルタイムで連絡するcha...

php CSV データ取得は fgetcsv 使う

PHP csvアップロードしてデータインポート作業がありましたが、fgetcsv使ってcsv処理につ...

Laravel tinker 使って DB データベース接続とコマンド

Laravel tinker REPLツール使ってDBアクセス、環境確認など対話式で楽しく遊べる...

Laravel Test についてのメモ

Laravel自動テスト行う際のコマンドと設定 faker 使ってデータ生成...

Laravel Log の基本設定＆使い方

Laravel Logの基本設定 エラー発生時にslackに連絡通知する設定方法 tailコマンド使...

Exception: Class 'ZipArchive' not found

エクセル操作でZipArchive classが見つからないエラーがあったので、対応しました。...

Laravel Sail で Docker 環境構築

Laravel Sail で Docker 開発環境PHP Mysql phpMyAdmin構築 s...

PHP 文字列長さ・文字列の幅を取得方法

PHP 文字列操作関数 マルチバイト文字列日本語韓国語中国語の長さ取得など...

Codeigniter 画像アップロードとリサイズ

Codeigniter アップロード画像リサイズと回転するなど画像操作するライブラリの使い方...

Laravel Lumen Faker 日本語設定

Laravel Faker 日本語化設定 fakerphpの使い方とよく使うオプション 名前や住所の...

laravel method の基本 get post put options

Laravel Routeでget post メソッド同時に設定したい！Laravel ルート制約の...

Class 'Imagick' not found Error

phpで画像操作したらimagickエラーで動かなくなったため、imagickモジュールをインストを...

Laravel eloquent model の規約

最新Laravel開発eloquent model設定資料まとめ...

PHP mbconvertkana 全角半角英数カナ変換

php カナコンバートなら mb_convert_kana を使う！全角半角、英数字や記号など簡単に...

Codeigniter APPPATH BASEPATH FCPATH 各種パスと URL 取得

codeigniter host url取得方法と APPPATH BASEPATHの意味を紹介...

Laravel timestamp() auto update 有効化無効化

Laravel updated_at timestamp自動にしたい！MysqlはすぐにできるけどS...

Lumen8 で JWT ユーザー認証

Lumen8でJWT認証のAPIサーバー構築してみた、便利になった時代だなあ...

Laravel toSql パラメータ付きで出力

Laravel Query Builder toSqlで出力したsql文にパラメータを自動でセット...

Lumen8 で API 開発

codeigniter 愛用者がLumenでAPIサーバーを立ててみた...

php Exception エラーキャッチでメール送信

エラーメッセージ、エラーコード、エラー詳細取得、php例外処理exceptionのいろいろ...

Smarty HTTP URL 取得できるサーバー関数

スマーティで取得するサーバー関数URLとenvなど...

Laravel blade foreach loop と current url

laravel blade foreach loop変数とurlのプロパティ対照表...

laravel session を制する

laravel sesssion 使い方を紹介、読込保存削除を使えるようになったらsession制覇...

PHP empty isset is_null の違い

PHP empty, isset, is_nullの違い よく使うPHP isset と if の違...

PHP 8 リリース新機能と変更

php8がリリースされたので、新機能と特徴などの資料まとめました。25周年迎えたPHPは更に速いプロ...

FlattenException deprecated

laravelバージョンアップ作業する際にFlattenException deprecatedにつ...

php.ini 初期設定のいろいろ

php ini ローカル環境や新規リモート環境の初期設定...

Laravel 5.1 から 8.1 にバージョンアップ

laravel5 から8にアップグレードする際に遭遇したエラーとカスタマイズauth認証の設定を修正...

PHP 7.4 にアップグレードして使えなくなる機能

php 5 から php7.4 にアップする作業があったので、アップグレード時のエラーと7.4では動...

開発時によく使うゼロ埋めパディング作業まとめ

mysql twig phpとjavascriptでよく使うゼロ埋めのいろいろ...

解決！phpMyAdmin テーブル構造の内容が表示されない問題

phpmyadmin5.0.1のxampp入れたら テーブル構造メニューが真っ白になって表示されない...

codeigniter email ライブラリでメール送信 日本語対応

codeigniterメール送信で日本語文字化け対策、改行コードとSMTP項目設定...

Composer コマンドとオプション

composer install updateの違い post-install-cmdとpost-u...

爆速軽量フレームワーク codeigniter PHP 開発

ルーター設定もなく、初期設定も少ない！軽量と爆速で動いてくれるフレームワーク codeigniter...

nuxtjs と codeigniter で jwt システム構築

nuxtjsとcodeigniterでシステム構築する際のメモ...

Lumen と Laravel 違い比較

軽量で速いマイクロフレームワークlumenとlaravelの違い、使い方比較と本当にlumen必要か...

HTML から PDF に変換 PHP ライブラリ mPDF の設定

HTMLレンダリングしてPDFに変換出力するライブリmpdfを使いこなせるための設定いろいろ...

twig 3 人気 PHP テンプレートエンジンがバージョンアップ

以前からtwigテンプレートエンジン使っていて、非常にパワーフルで使いやすさに魅了しました。15日に...

正規表現一覧 よく使う検索・置換のパターン

よく使う正規表現、文字検索・置換をまとめてみました。...

Apache 初期設定メモ

LAMP環境のApache初期設定メモ...

開発におけるコーディングルール・規約

コーディングルールと規約を大事にする、複数人で開発しても、一人で開発してもメンテナンスやコードのわか...

Laravel Error についてのメモ

laravelを使う時に出てくるエラー対応...

laravel に vuejs 使うための初期設定

PHPフレームワークlaravelにvuejs入れる時の初期設定まとめ、備忘録的...

php curl 使って クリックなしで POST 送信

PHP curl_setopt使ってシンプルにデータ転送してpost投げます。PHPは本当に短いソー...

allowurlinclude の設定で ftp_connect()エラー

FTPサーバーとやりとりする時にftp_connect()エラーが発生、PHP７にアップしたばかりで...