【PHP8.x】__constructメソッドの使い方

Copy
1<?php
2
3/**
4 * このクラスは期間文字列を保持し、必要に応じてDateIntervalオブジェクトを生成します。
5 * PHP 8以降で導入されたConstructor Property Promotion (コンストラクタプロパティ昇格) の利用例を示します。
6 */
7class MyFlexibleDuration
8{
9    /**
10     * PHP 8のConstructor Property Promotion (コンストラクタプロパティ昇格) を使用して、
11     * コンストラクタの引数 $durationString を直接プロパティとして定義・初期化します。
12     * これにより、冗長なプロパティ宣言と代入の記述が不要になります。
13     * 'readonly' キーワードにより、このプロパティは一度初期化されると変更不可になります。
14     *
15     * 注意点: DateInterval::__construct はPHPの組み込みメソッドであり、
16     * Constructor Property Promotion を直接適用することはできません。
17     * ここでは、ユーザー定義クラスでこの機能を利用しつつ、
18     * DateInterval::__construct を内部で呼び出す例を示します。
19     *
20     * @param string $durationString ISO 8601 形式の期間文字列 (例: P1Y2M3DT4H5M6S)
21     */
22    public function __construct(
23        public readonly string $durationString
24    ) {
25        // コンストラクタプロパティ昇格により、$this->durationString は既に初期化されています。
26        // DateIntervalオブジェクトは、必要になったときに toDateInterval() メソッドで生成します。
27    }
28
29    /**
30     * 保持している期間文字列から DateInterval オブジェクトを生成して返します。
31     * DateInterval::__construct メソッドをここで呼び出します。
32     *
33     * @return DateInterval 期間を表すDateIntervalオブジェクト
34     */
35    public function toDateInterval(): DateInterval
36    {
37        // DateIntervalのコンストラクタを呼び出し、保持している期間文字列を渡します。
38        // 引数: string $duration
39        return new DateInterval($this->durationString);
40    }
41
42    /**
43     * 期間情報を人間が読める形式で取得します。
44     *
45     * @return string フォーマットされた期間情報
46     */
47    public function getFormattedDuration(): string
48    {
49        $interval = $this->toDateInterval();
50        // DateInterval::format() メソッドを使用して、期間を整形します。
51        return $interval->format('%y年%mヶ月%d日 %h時間%i分%s秒');
52    }
53}
54
55// --- サンプルコードの使用例 ---
56
57// MyFlexibleDuration クラスのインスタンスを作成します。
58// コンストラクタにISO 8601形式の期間文字列 (P1Y2M3DT4H5M6S = 1年2ヶ月3日4時間5分6秒) を渡します。
59$myDuration = new MyFlexibleDuration('P1Y2M3DT4H5M6S');
60
61// Constructor Property Promotion により、プロパティ $durationString に直接アクセスできます。
62echo "元の期間文字列: " . $myDuration->durationString . PHP_EOL;
63
64// toDateInterval() メソッドを使って DateInterval オブジェクトを取得します。
65$dateIntervalObject = $myDuration->toDateInterval();
66echo "DateInterval オブジェクトの年: " . $dateIntervalObject->y . PHP_EOL;
67echo "DateInterval オブジェクトの月: " . $dateIntervalObject->m . PHP_EOL;
68echo "DateInterval オブジェクトの日: " . $dateIntervalObject->d . PHP_EOL;
69
70// フォーマットされた期間情報を表示します。
71echo "フォーマットされた期間: " . $myDuration->getFormattedDuration() . PHP_EOL;
72
73echo PHP_EOL;
74
75// 別の期間で試します。 (PT30M = 30分)
76$anotherDuration = new MyFlexibleDuration('PT30M');
77echo "別の期間文字列: " . $anotherDuration->durationString . PHP_EOL;
78echo "別の期間フォーマット: " . $anotherDuration->getFormattedDuration() . PHP_EOL;
79
80?>

PHPのDateInterval::__constructメソッドは、日付や時間の期間を表現するDateIntervalオブジェクトを生成する際に使用されます。このコンストラクタは、ISO 8601形式の期間文字列（例: P1Y2M3DT4H5M6S は1年2ヶ月3日4時間5分6秒を意味します）を引数として受け取ります。具体的な戻り値はありませんが、呼び出しの結果としてDateIntervalの新しいインスタンスが構築されます。

提供されたサンプルコードでは、DateInterval::__constructを直接呼び出すのではなく、PHP 8で導入された「Constructor Property Promotion（コンストラクタプロパティ昇格）」という機能を利用したMyFlexibleDurationクラスが示されています。この機能により、コンストラクタの引数$durationStringをpublic readonlyプロパティとして直接定義し、コードを簡潔に保っています。readonlyキーワードは、一度初期化されたプロパティの値が変更されないことを保証します。

MyFlexibleDurationクラスは、期間文字列を内部に保持し、必要なときにtoDateInterval()メソッドを呼び出すことで、内部でDateInterval::__constructを使って実際のDateIntervalオブジェクトを生成します。例えば、new DateInterval($this->durationString);という形で、保持している期間文字列から新しい期間オブジェクトが作成されます。この設計により、期間文字列の管理とDateIntervalオブジェクトの生成を柔軟に行うことが可能になります。

Copy
1<?php
2
3/**
4 * DateInterval クラスを継承したカスタム期間クラスの例。
5 *
6 * この例では、子クラスのコンストラクタ内で `parent::__construct` を使用して、
7 * 親クラス (DateInterval) のコンストラクタを呼び出す方法を示します。
8 * これにより、親クラスの初期化ロジックが実行され、DateInterval の機能が利用可能になります。
9 */
10class MyDateInterval extends DateInterval
11{
12    /**
13     * MyDateInterval クラスのコンストラクタ。
14     *
15     * @param string $duration ISO 8601 形式または PHP 独自の期間指定文字列。
16     *                         例: 'P1Y2M3DT4H5M6S' (1年2ヶ月3日と4時間5分6秒)
17     */
18    public function __construct(string $duration)
19    {
20        // 親クラス (DateInterval) のコンストラクタを呼び出します。
21        // ここで `$duration` 文字列が解析され、DateInterval オブジェクトの
22        // 各プロパティ (年、月、日、時間など) が設定されます。
23        parent::__construct($duration);
24
25        // 必要に応じて、子クラス独自の初期化処理を追加できます。
26        // 例: 特定のログ出力や、追加のプロパティ設定など。
27    }
28
29    /**
30     * この期間の情報を人間が読める形式の文字列で返します。
31     * `parent::__construct` によって設定された親クラスのプロパティが
32     * 正しく機能していることを示します。
33     */
34    public function getHumanReadableDuration(): string
35    {
36        $parts = [];
37        if ($this->y > 0) {
38            $parts[] = $this->y . '年';
39        }
40        if ($this->m > 0) {
41            $parts[] = $this->m . 'ヶ月';
42        }
43        if ($this->d > 0) {
44            $parts[] = $this->d . '日';
45        }
46
47        $timeParts = [];
48        if ($this->h > 0) {
49            $timeParts[] = $this->h . '時間';
50        }
51        if ($this->i > 0) {
52            $timeParts[] = $this->i . '分';
53        }
54        if ($this->s > 0) {
55            $timeParts[] = $this->s . '秒';
56        }
57
58        $result = '';
59        if (!empty($parts)) {
60            $result .= implode('', $parts);
61        }
62        if (!empty($timeParts)) {
63            if (!empty($result)) {
64                $result .= 'と'; // 日付部分と時間部分を「と」で繋ぐ
65            }
66            $result .= implode('', $timeParts);
67        }
68
69        return !empty($result) ? $result : '期間が指定されていません。';
70    }
71}
72
73// --- サンプルコードの実行 ---
74
75// MyDateInterval クラスのインスタンスを作成します。
76// 'P1Y2M3DT4H5M' は「1年2ヶ月3日と4時間5分」を意味します。
77$interval1 = new MyDateInterval('P1Y2M3DT4H5M');
78
79echo "--- 期間1: P1Y2M3DT4H5M ---\n";
80// parent::__construct() によって設定された DateInterval のプロパティにアクセスします。
81echo "年: " . $interval1->y . "年\n";
82echo "月: " . $interval1->m . "ヶ月\n";
83echo "日: " . $interval1->d . "日\n";
84echo "時間: " . $interval1->h . "時間\n";
85echo "分: " . $interval1->i . "分\n";
86echo "秒: " . $interval1->s . "秒\n"; // この期間では秒は0
87
88// 子クラス独自のメソッドを使って、期間を人間が読める形式で表示します。
89echo "人間が読める形式: " . $interval1->getHumanReadableDuration() . "\n";
90
91echo "\n";
92
93// 別の期間で試します。'P7D' は「7日間」を意味します。
94$interval2 = new MyDateInterval('P7D');
95echo "--- 期間2: P7D ---\n";
96echo "人間が読める形式: " . $interval2->getHumanReadableDuration() . "\n";
97
98echo "\n";
99
100// さらに別の期間で試します。'PT30M15S' は「30分15秒」を意味します。
101$interval3 = new MyDateInterval('PT30M15S');
102echo "--- 期間3: PT30M15S ---\n";
103echo "人間が読める形式: " . $interval3->getHumanReadableDuration() . "\n";
104
105?>

PHPのDateInterval::__constructメソッドは、指定された期間を表すオブジェクトを新しく作成し、初期化するために使用されるコンストラクタです。

引数$durationには、'P1Y2M3DT4H5M6S'のようなISO 8601形式、またはPHP独自の期間指定文字列を渡します。この文字列が解析され、作成されるDateIntervalオブジェクトの内部プロパティ（年、月、日、時間、分、秒など）が自動的に設定されます。コンストラクタであるため、明示的な戻り値はありません。

サンプルコードでは、DateIntervalクラスを継承したMyDateIntervalクラスを定義しています。この子クラスのコンストラクタ内でparent::__construct($duration)を呼び出している点が重要です。この記述により、親クラスであるDateIntervalのコンストラクタが実行され、渡された$duration文字列に基づいて期間の解析と必要な初期設定が行われます。

このparent::__constructの呼び出しによって、MyDateIntervalのインスタンスは、親クラスが持つ期間情報（例えば$this->yで年、$this->mで月など）を正しく利用できるようになります。サンプルコードのgetHumanReadableDuration()メソッドは、この初期化されたプロパティを利用して、期間を人間が読める形式で表示しており、parent::__constructが適切に機能していることを示しています。このように、parent::__constructは、継承元クラスの初期化ロジックを確実に実行し、その機能を子クラスで利用するために不可欠な記述です。