【PHP】Carbonインスタンスに指定した日数を足すことができるCarbon::addDaysメソッドを解説します

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

この記事では、 PHPでCarbonインスタンスに指定した日数を足すことができるCarbon::addDaysメソッドについて

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

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

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

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

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

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

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

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

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

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

Carbon::addDaysメソッドとは

Carbon::addDaysメソッドとは、呼び出しているCarbonインスタンスに引数で指定されている日数を足すメソッドです。

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

$sample = new Carbon('2000-01-01');
$sample->addDays(10);

1 2	$sample = new Carbon('2000-01-01'); $sample->addDays(10);

実行後は変数sampleは

2000-01-11 00:00:00

1	2000-01-11 00:00:00

という値になっています。

Carbon::addDaysメソッドの引数は任意設定です。
設定しなかった場合、1日追加されます。
ちなみに引数には負の整数も設定でき、その場合指定した数だけ日数が引かれます。

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

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

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

引数指定なしの場合
引数指定ありの場合

の2パターンでCarbon::addDaysメソッドを実行し、結果を表示させます。

phpプログラムは

C:\xampp\htdocs

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

PHPサンプルプログラム

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

	use Carbon\Carbon;

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

	print('・引数指定なしの場合<br >');
	$carbon1 = new Carbon('2024-02-01');
	print("実行前：".$carbon1);
	$carbon1->addDays();
	print("<br >");
	print("実行後：".$carbon1);
	print("<br >");

	print('・引数指定ありの場合<br >');
	$carbon2 = new Carbon('2024-02-01');
	print("実行前：".$carbon2);
	$carbon2->addDays(15);
	print("<br >");
	print("実行後：".$carbon2);
	print("<br >");
?>

<?php

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

use Carbon\Carbon;

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

print('・引数指定なしの場合 ');

$carbon1 = new Carbon('2024-02-01');

print("実行前：".$carbon1);

$carbon1->addDays();

print(" ");

print("実行後：".$carbon1);

print(" ");

print('・引数指定ありの場合 ');

$carbon2 = new Carbon('2024-02-01');

print("実行前：".$carbon2);

$carbon2->addDays(15);

print(" ");

print("実行後：".$carbon2);

print(" ");

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

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

実行結果

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

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

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

PHPのCarbon::addDaysメソッドを解説
引数を指定なしの場合は1日、引数を指定している場合は指定した日数分足していることが確認できました！

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

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

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