【PHP8.x】intervalプロパティの使い方

intervalプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年10月20日

基本的な使い方

DatePeriodクラスのintervalプロパティは、DatePeriodオブジェクトが反復処理を行う際に使用するDateIntervalオブジェクトを保持するプロパティです。DatePeriodは、開始日時、終了日時、そしてこのintervalプロパティで指定された間隔に基づいて、一連の日時を生成します。

このプロパティは読み取り専用であり、DatePeriodオブジェクトの構築時に指定されたDateIntervalオブジェクトを後から変更することはできません。DateIntervalオブジェクトは、日時間の差を表すオブジェクトであり、年、月、日、時、分、秒などの単位で間隔を指定できます。

例えば、毎週月曜日の日付を1年間生成するDatePeriodオブジェクトを作成する場合、開始日時をその年の最初の月曜日に設定し、終了日時を年末に設定し、intervalプロパティに「1週間」を表すDateIntervalオブジェクトを設定します。DatePeriodオブジェクトが反復処理されるたびに、intervalプロパティに保持されたDateIntervalオブジェクトが開始日時に加算され、次の日時が生成されます。

intervalプロパティは、DatePeriodオブジェクトの動作を決定する重要な要素であり、DatePeriodオブジェクトを使用する際には、適切なDateIntervalオブジェクトを設定する必要があります。このプロパティに設定されたDateIntervalオブジェクトに基づいて、DatePeriodオブジェクトが生成する日時系列が決定されるため、期待通りの日時系列を生成するためには、DateIntervalオブジェクトを正確に指定することが重要です。DatePeriodオブジェクトを利用して、特定の期間における定期的なイベントやスケジュールを扱う場合に、このintervalプロパティが効果的に活用できます。

構文(syntax)


1<?php
2$start = new DateTime('2024-01-01');
3$end = new DateTime('2024-01-10');
4$interval = new DateInterval('P1D');
5$period = new DatePeriod($start, $interval, $end);
6
7echo $period->interval->format('%d days');
8?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

DateInterval

DatePeriod オブジェクトが表す期間の間隔を表す DateInterval オブジェクトを返します。

サンプルコード

PHP DatePeriod から interval を取得する


1<?php
2
3// DatePeriod オブジェクトから DateInterval オブジェクトを取得する例
4$start = new DateTime('2024-01-01');
5$end = new DateTime('2024-01-10');
6$interval = new DateInterval('P1D'); // 1日ごとの間隔
7
8$period = new DatePeriod($start, $interval, $end);
9
10// DatePeriod オブジェクトの interval プロパティにアクセス
11$dateInterval = $period->interval;
12
13// DateInterval オブジェクトの情報を出力
14echo "Interval: " . $dateInterval->format('%R%a days') . PHP_EOL;
15
16?>

このPHPのサンプルコードは、DatePeriodオブジェクトから期間を表すDateIntervalオブジェクトを取得する方法を示しています。DatePeriodは、開始日時、期間、終了日時（または繰り返し回数）に基づいて、一連の日時オブジェクトを生成する際に使用されるクラスです。

最初に、DateTimeクラスを使って開始日時と終了日時を定義し、DateIntervalクラスを使って期間（この例では1日）を定義します。これらの情報をもとにDatePeriodオブジェクトを生成します。

DatePeriodオブジェクトのintervalプロパティにアクセスすることで、そのDatePeriodオブジェクトが持つDateIntervalオブジェクトを取得できます。intervalプロパティは、DatePeriodが生成する日時オブジェクトの間隔を表すDateIntervalオブジェクトを保持しています。

取得したDateIntervalオブジェクトは、format()メソッドを使って文字列として出力できます。この例では、%R%a daysというフォーマット指定子を使用しており、期間が何日であるかを表示します。%Rは符号（正または負）を示し、%aは期間の合計日数を表します。

このコードを通じて、DatePeriodオブジェクトがどのように期間情報を保持し、intervalプロパティを通じてDateIntervalオブジェクトとしてアクセスできるかを理解できます。システム開発において、特定の日時範囲における繰り返し処理や、期間に関する情報を扱う際に役立つ知識です。

DatePeriodクラスのintervalプロパティは、期間を表すDateIntervalオブジェクトを返します。サンプルコードでは、$period->intervalでDateIntervalオブジェクトを取得しています。

注意点として、intervalプロパティは読み取り専用です。値を直接変更することはできません。期間を変更したい場合は、新しいDatePeriodオブジェクトを作成する必要があります。

DateIntervalオブジェクトのformat()メソッドを使用する際は、書式指定子に注意してください。%R%a daysは、期間を「符号付きの日数」として表示する例です。他の書式指定子を使用することで、年、月、時間など、様々な形式で期間を表示できます。DateIntervalオブジェクトのドキュメントを参照し、目的に合った書式指定子を選択してください。

PHP DatePeriod interval を秒数に変換する


1<?php
2
3/**
4 * DatePeriod オブジェクトから DateInterval オブジェクトを取得し、秒数に変換するサンプル
5 */
6function getDateIntervalSeconds(DatePeriod $period): int
7{
8    $interval = $period->interval; // DatePeriod オブジェクトから DateInterval オブジェクトを取得
9    return $interval->s + ($interval->i * 60) + ($interval->h * 3600) + ($interval->d * 86400) + ($interval->m * 2592000) + ($interval->y * 31536000); // DateInterval オブジェクトを秒数に変換
10}
11
12// サンプルの DatePeriod オブジェクトを作成
13$start = new DateTime('2024-01-01');
14$end = new DateTime('2024-01-05');
15$interval = new DateInterval('P1D'); // 1日ごとの DateInterval
16$period = new DatePeriod($start, $interval, $end);
17
18// 秒数に変換して出力
19$seconds = getDateIntervalSeconds($period);
20echo "DateInterval の秒数: " . $seconds . PHP_EOL;
21

このサンプルコードは、DatePeriodオブジェクトが持つ期間（intervalプロパティ）を秒数に変換する方法を示しています。DatePeriodクラスのintervalプロパティは、期間を表すDateIntervalオブジェクトを返します。

関数getDateIntervalSecondsは、DatePeriodオブジェクトを受け取り、その期間を秒数に変換して返します。まず、$period->intervalでDatePeriodオブジェクトからDateIntervalオブジェクトを取得します。

DateIntervalオブジェクトは、年(y)、月(m)、日(d)、時間(h)、分(i)、秒(s)といった期間の要素を保持しています。これらの要素をそれぞれ秒数に換算し、合計することで、期間全体の秒数を算出します。具体的には、年を31536000秒、月を2592000秒、日を86400秒、時間を3600秒、分を60秒として計算しています。

サンプルでは、DatePeriodオブジェクトを生成する際に、1日ごとのDateInterval('P1D')を指定しています。そのため、getDateIntervalSeconds関数は、この1日という期間を秒数（86400秒）に変換して返します。最後に、変換された秒数が出力されます。このコードは、DateIntervalオブジェクトから期間を取得し、秒数として扱いたい場合に役立ちます。

DatePeriodのintervalプロパティはDateIntervalオブジェクトを返します。このオブジェクトは期間を表し、年、月、日、時、分、秒といった要素を含みます。サンプルコードでは、これらの要素を単純に足し合わせて秒数を計算していますが、これは概算である点に注意が必要です。月や年の長さは一定ではないため、正確な秒数を求めるには、DateTimeオブジェクトを使って計算する必要があります。例えば、開始日時とDateIntervalを足し合わせ、終了日時との差をDateIntervalで取得し、その差を秒数に換算する方法が考えられます。また、このコードは大きな期間の場合に整数オーバーフローを起こす可能性があります。より大きな値を扱えるように、必要に応じて型を検討してください。