【PHP】Carbonインスタンスを月の初日に設定できるCarbon::startOfMonthメソッドを解説します

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

この記事では、 PHPでCarbonインスタンスを月の初日に設定できるCarbon::startOfMonthメソッドについて

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

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

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

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

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

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

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

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

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

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

Carbon::startOfMonthメソッドとは

Carbon::startOfMonthメソッドとは、呼び出しているCarbonインスタンスをその月の初日、かつ時間をその日が始まった時間に設定することができるメソッドです。
返り値として、設定したCarbonインスタンスそのものも返します。

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

$sample = new Carbon('2023-10-11');
$result = $sample->startOfMonth();

1 2	$sample = new Carbon('2023-10-11'); $result = $sample->startOfMonth();

実行後は変数resultには

2023-10-01 00:00:00

1	2023-10-01 00:00:00

が返され、変数sampleも同じ値になっています。

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

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

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

今日のCarbonインスタンスの場合
月末のCarbonインスタンスの場合

の2つのパターンでCarbon::startOfMonthメソッドを実行します。
実行前後でCarbonインスタンスがどうなっているかを表示させて確認します。

phpプログラムは

C:\xampp\htdocs

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

PHPサンプルプログラム

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

	use Carbon\Carbon;

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

	print('・今日のCarbonインスタンスの場合<br >');
	$date1 = Carbon::today();
	print("実行前->".$date1.'<br >');
	$date1->startOfMonth();
	print("実行後->".$date1.'<br >');

	print('・月末のCarbonインスタンスの場合<br >');
	$date2 = new Carbon('2023-01-31 23:59:59');
	print("実行前->".$date2.'<br >');
	$date2->startOfMonth();
	print("実行後->".$date2.'<br >');
?>

<?php

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

use Carbon\Carbon;

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

print('・今日のCarbonインスタンスの場合 ');

$date1 = Carbon::today();

print("実行前->".$date1.' ');

$date1->startOfMonth();

print("実行後->".$date1.' ');

print('・月末のCarbonインスタンスの場合 ');

$date2 = new Carbon('2023-01-31 23:59:59');

print("実行前->".$date2.' ');

$date2->startOfMonth();

print("実行後->".$date2.' ');

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

Carbon::todayメソッド
【PHP】今日のCarbonインスタンスを生成するCarbon::todayメソッドについて解説します

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

実行結果

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

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

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

PHPのCarbon::startOfMonthメソッドを解説
呼び出しているCarbonインスタンスの月の初日、かつ時間をその日が始まった時間に設定できていることが確認できました！

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

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

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