【PHP】Carbonインスタンスが未来かどうかを判定できるCarbon::gtメソッドを解説します

こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在5社経験している、12年目エンジニアです。

この記事では、 PHPでCarbonインスタンスが未来かどうかを判定できるCarbon::gtメソッドについて

Carbon::gtメソッドとは
Carbon::gtメソッドを使ったサンプルプログラム

と、丁寧に解説していきます。

前提条件：実行環境について
Carbon::gtメソッドとは
Carbon::gtメソッドを解説するプログラムの概要
PHPサンプルプログラム
実行結果
まとめ：Carbon::gtメソッドを使ってみよう！

前提条件：実行環境について

実行環境は以下の通りです。

OS	Windows11
PHPのバージョン	8.2.4
XAMPPのバージョン	8.2.4
Carbonライブラリのバージョン	2.71.0

PHPを動かすためにXAMPPを使っています。
XAMPPのインストールは、下の記事をご参考ください。

【XAMPP】インストールするやり方を解説します（Windows11向け）

Carbon::gtメソッドが属しているCarbonライブラリとは、年月日や時間を扱うライブラリです。
Carbonライブラリの基本的な使い方については、こちらの記事をご参考ください。

【PHP】Carbonライブラリの基本的な使い方を解説します

Carbon::gtメソッドとは

Carbon::gtメソッドとは、呼び出しているCarbonインスタンスが引数で指定しているCarbonインスタンスより大きい、すなわち未来かどうかを判定し結果をboolで返すメソッドです。
未来であればtrue、それ以外はfalseを返します。

使い方サンプルは以下になります。

$date1 = Carbon::today();
$date2 = Carbon::yesterday();
$result = $date1->gt($date2);

$date1 = Carbon::today();

$date2 = Carbon::yesterday();

$result = $date1->gt($date2);

変数resultには「true」が返されます。

では、次の章で実際に使ってみます。

Carbon::gtメソッドを解説するプログラムの概要

Carbon::gtメソッドを解説するプログラムでは

呼び出しているCarbonインスタンスが未来の場合
引数と呼び出しているCarbonインスタンスが同年月日の場合
引数のCarbonインスタンスが未来の場合

の3つのパターンでCarbon::gtメソッドで判定し、結果を表示させます。

phpプログラムは

C:\xampp\htdocs

配下に、【sample.php】というファイル名で格納しています。
PHPのCarbon::isTomorrowメソッドを解説

PHPサンプルプログラム

<?php
	require __DIR__ . "/../vendor/autoload.php";

	use Carbon\Carbon;

	print('■Carbon::gtメソッドサンプル<br >');

	print('・呼び出しているCarbonインスタンスが未来の場合<br >');
	$date1 = new Carbon('2023-12-01 12:00:02');
	$date2 = new Carbon('2023-12-01 12:00:00');
	print('呼び出し側：'.$date1.'<br >');
	print('引数　　　：'.$date2.'<br >');

	if ($date1->gt($date2)) {
		print($date1."が未来です");
	} else {
		print($date2."が未来、または同年月日です");
	}
	print("<br >");

	print('・引数と呼び出しているCarbonインスタンスが同年月日の場合<br >');
	$date3 = new Carbon('2023-12-01 12:00:00');
	$date4 = new Carbon('2023-12-01 12:00:00');
	print('呼び出し側：'.$date3.'<br >');
	print('引数　　　：'.$date4.'<br >');

	if ($date3->gt($date4)) {
		print($date3."が未来です");
	} else {
		print($date4."が未来、または同年月日です");
	}
	print("<br >");

	print('・引数のCarbonインスタンスが未来の場合<br >');
	$date5 = new Carbon('2023-12-01 12:00:00');
	$date6 = new Carbon('2023-12-01 12:00:01');
	print('呼び出し側：'.$date5.'<br >');
	print('引数　　　：'.$date6.'<br >');

	if ($date5->gt($date6)) {
		print($date5."が未来です");
	} else {
		print($date6."が未来、または同年月日です");
	}
?>

<?php

require __DIR__ . "/../vendor/autoload.php";

use Carbon\Carbon;

print('■Carbon::gtメソッドサンプル ');

print('・呼び出しているCarbonインスタンスが未来の場合 ');

$date1 = new Carbon('2023-12-01 12:00:02');

$date2 = new Carbon('2023-12-01 12:00:00');

print('呼び出し側：'.$date1.' ');

print('引数　　　：'.$date2.' ');

if ($date1->gt($date2)) {

print($date1."が未来です");

} else {

print($date2."が未来、または同年月日です");

}

print(" ");

print('・引数と呼び出しているCarbonインスタンスが同年月日の場合 ');

$date3 = new Carbon('2023-12-01 12:00:00');

$date4 = new Carbon('2023-12-01 12:00:00');

print('呼び出し側：'.$date3.' ');

print('引数　　　：'.$date4.' ');

if ($date3->gt($date4)) {

print($date3."が未来です");

} else {

print($date4."が未来、または同年月日です");

}

print(" ");

print('・引数のCarbonインスタンスが未来の場合 ');

$date5 = new Carbon('2023-12-01 12:00:00');

$date6 = new Carbon('2023-12-01 12:00:01');

print('呼び出し側：'.$date5.' ');

print('引数　　　：'.$date6.' ');

if ($date5->gt($date6)) {

print($date5."が未来です");

} else {

print($date6."が未来、または同年月日です");

}

Carbonインスタンスをnewで生成するやり方は、こちらの記事をご参考ください。

【PHP】Carbonインスタンスをnewで生成するやり方について解説します

実行結果

XAMPPを起動して、【http://localhost/sample.php】のURLにアクセスします。

XAMPPでPHPの動かし方については、こちらの記事をご参考ください。

XAMPPでApacheの動かし方を解説します（Windows11向け）

PHPのCarbon::gtメソッドを解説
呼び出しているCarbonインスタンスが未来のケースのみtrueが返されていることが確認できました！

まとめ：Carbon::gtメソッドを使ってみよう！

以上がCarbon::gtメソッドについての解説でした！

あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ