【PHP】Carbonインスタンスが同じ日付かどうかを判定できるCarbon::equalToメソッドを解説します

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

この記事では、 PHPでCarbonインスタンスが同じ日付かどうかを判定できるCarbon::equalToメソッドについて

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

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

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

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

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

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

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

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

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

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

Carbon::equalToメソッドとは

Carbon::equalToメソッドとは、呼び出しているCarbonインスタンスと引数で指定しているCarbonインスタンスが同じ日付、同じ時間かどうかを判定し結果をboolで返すメソッドです。
すべて同じであればtrue、それ以外はfalseを返します。

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

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

$date1 = Carbon::today();

$date2 = Carbon::today();

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

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

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

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

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

ちがう年月日のCarbonインスタンスの場合
同年月日で時刻が異なるCarbonインスタンスの場合
同年月日同時刻のCarbonインスタンスの場合

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

phpプログラムは

C:\xampp\htdocs

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

PHPサンプルプログラム

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

	use Carbon\Carbon;

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

	print('・ちがう年月日のCarbonインスタンスの場合<br >');
	$date1 = new Carbon('2023-02-02');
	$date2 = new Carbon('2022-12-20');

	print($date1."と".$date2."は");
	if ($date1->equalTo($date2)) {
		print("同年月日同時刻です");
	} else {
		print("同年月日同時刻ではありません");
	}
	print("<br >");

	print('・同年月日で時刻が異なるCarbonインスタンスの場合<br >');
	$date3 = new Carbon('2023-09-09 12:33:44');
	$date4 = new Carbon('2023-09-09 14:10:33');

	print($date3."と".$date4."は");
	if ($date3->equalTo($date4)) {
		print("同年月日同時刻です");
	} else {
		print("同年月日同時刻ではありません");
	}
	print("<br >");

	print('・同年月日同時刻のCarbonインスタンスの場合<br >');
	$date5 = new Carbon('2020-01-01 11:11:11');
	$date6 = new Carbon('2020-01-01 11:11:11');

	print($date5."と".$date6."は");
	if ($date5->equalTo($date6)) {
		print("同年月日同時刻です");
	} else {
		print("同年月日同時刻ではありません");
	}
?>

<?php

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

use Carbon\Carbon;

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

print('・ちがう年月日のCarbonインスタンスの場合 ');

$date1 = new Carbon('2023-02-02');

$date2 = new Carbon('2022-12-20');

print($date1."と".$date2."は");

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

print("同年月日同時刻です");

} else {

print("同年月日同時刻ではありません");

}

print(" ");

print('・同年月日で時刻が異なるCarbonインスタンスの場合 ');

$date3 = new Carbon('2023-09-09 12:33:44');

$date4 = new Carbon('2023-09-09 14:10:33');

print($date3."と".$date4."は");

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

print("同年月日同時刻です");

} else {

print("同年月日同時刻ではありません");

}

print(" ");

print('・同年月日同時刻のCarbonインスタンスの場合 ');

$date5 = new Carbon('2020-01-01 11:11:11');

$date6 = new Carbon('2020-01-01 11:11:11');

print($date5."と".$date6."は");

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

print("同年月日同時刻です");

} else {

print("同年月日同時刻ではありません");

}

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

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

実行結果

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

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

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

PHPのCarbon::equalToメソッドを解説
Carbonインスタンスが同じ年月日、同じ時刻のケースのみtrueが返されていることが確認できました！

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

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

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