こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在5社経験している、12年目エンジニアです。
この記事では、 PHPでCarbonインスタンスを月末に設定できるCarbon::endOfMonthメソッドについて
- Carbon::endOfMonthメソッドとは
- Carbon::endOfMonthメソッドを使ったサンプルプログラム
と、丁寧に解説していきます。
前提条件：実行環境について
実行環境は以下の通りです。
| OS | Windows11 |
|---|---|
| PHPのバージョン | 8.2.4 |
| XAMPPのバージョン | 8.2.4 |
| Carbonライブラリのバージョン | 2.71.0 |
PHPを動かすためにXAMPPを使っています。
XAMPPのインストールは、下の記事をご参考ください。
Carbon::endOfMonthメソッドが属しているCarbonライブラリとは、年月日や時間を扱うライブラリです。
Carbonライブラリの基本的な使い方については、こちらの記事をご参考ください。
Carbon::endOfMonthメソッドとは
Carbon::endOfMonthメソッドとは、呼び出しているCarbonインスタンスをその月の月末、かつ時間をその日の最後の時間に設定することができるメソッドです。
返り値として、設定したCarbonインスタンスそのものも返します。
使い方サンプルは以下になります。
|
1 2 |
$sample = new Carbon('2023-10-11'); $result = $sample->endOfMonth(); |
実行後は変数resultには
|
1 |
2023-10-31 23:59:59 |
が返され、変数sampleも同じ値になっています。
では、次の章で実際に使ってみます。
Carbon::endOfMonthメソッドを解説するプログラムの概要
Carbon::endOfMonthメソッドを解説するプログラムでは
- 今日のCarbonインスタンスの場合
- うるう月（閏月）のCarbonインスタンスの場合
の2つのパターンでCarbon::endOfMonthメソッドを実行します。
実行前後でCarbonインスタンスがどうなっているかを表示させて確認します。
phpプログラムは
C:\xampp\htdocs
配下に、【sample.php】というファイル名で格納しています。
PHPサンプルプログラム
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
<?php require __DIR__ . "/../vendor/autoload.php"; use Carbon\Carbon; print('■Carbon::endOfMonthメソッドサンプル<br >'); print('・今日のCarbonインスタンスの場合<br >'); $date1 = Carbon::today(); print("実行前->".$date1.'<br >'); $date1->endOfMonth(); print("実行後->".$date1.'<br >'); print('・うるう月（閏月）のCarbonインスタンスの場合<br >'); $date2 = new Carbon('2024-02-01'); print("実行前->".$date2.'<br >'); $date2->endOfMonth(); print("実行後->".$date2.'<br >'); ?> |
Carbon::todayメソッドと、Carbonインスタンスをnewで生成するやり方は、こちらの記事をご参考ください。
【PHP】今日のCarbonインスタンスを生成するCarbon::todayメソッドについて解説します
Carbonインスタンスをnewで生成するやり方
【PHP】Carbonインスタンスをnewで生成するやり方について解説します
実行結果
XAMPPを起動して、【http://localhost/sample.php】のURLにアクセスします。
XAMPPでPHPの動かし方については、こちらの記事をご参考ください。
呼び出しているCarbonインスタンスの月末、かつ時間をその日の最後の時間に設定できていることが確認できました！
まとめ：Carbon::endOfMonthメソッドを使ってみよう！
以上がCarbon::endOfMonthメソッドについての解説でした！
あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ
コメント