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

Copy
1<?php
2
3// DateTimeクラスの__constructメソッドとPHP 8のコンストラクタプロパティプロモーションを組み合わせた例。
4// コンストラクタプロパティプロモーションとは、コンストラクタの引数を直接クラスのプロパティとして宣言するPHP 8の機能です。
5
6class SimpleDate
7{
8    // PHP 8のコンストラクタプロパティプロモーションにより、
9    // $datetimeStringと$timezoneは自動的にこのクラスのprivateプロパティとして定義されます。
10    // その後、これらのプロパティはコンストラクタの内部でアクセス可能になります。
11    private DateTime $date;
12
13    /**
14     * 新しい日付オブジェクトを初期化します。
15     * 引数 ($datetimeString, $timezone) はプロパティとして昇格され、
16     * DateTime::__construct メソッドに渡されます。
17     *
18     * @param string             $datetimeString 日付と時刻を表す文字列 (例: 'now', '2023-10-27 10:30:00', 'tomorrow')。
19     *                                           DateTime::__construct の最初の引数として使用されます。
20     * @param ?DateTimeZone|null $timezone       オプションのタイムゾーンオブジェクト。nullの場合、PHPのデフォルトタイムゾーンが使用されます。
21     *                                           DateTime::__construct の二番目の引数として使用されます。
22     */
23    public function __construct(
24        private string $datetimeString = 'now',
25        private ?DateTimeZone $timezone = null
26    ) {
27        // ここで、昇格されたプロパティ ($this->datetimeString, $this->timezone) を使用して、
28        // DateTimeクラスのコンストラクタ (DateTime::__construct) を呼び出し、
29        // 新しいDateTimeオブジェクトを生成して、クラスの$dateプロパティに格納します。
30        $this->date = new DateTime($this->datetimeString, $this->timezone);
31    }
32
33    /**
34     * フォーマットされた日付と時刻を返します。
35     *
36     * @return string 'YYYY-MM-DD HH:MM:SS T' 形式の文字列。
37     */
38    public function getFormattedDate(): string
39    {
40        return $this->date->format('Y-m-d H:i:s T');
41    }
42
43    /**
44     * この日付オブジェクトが使用しているタイムゾーン名を返します。
45     *
46     * @return string タイムゾーン名。
47     */
48    public function getTimezoneName(): string
49    {
50        // 昇格された$timezoneプロパティに直接アクセスします。
51        // nullの場合に備え、nullsafe演算子 (?->) を使用しています。
52        return $this->timezone?->getName() ?? 'System Default (null provided)';
53    }
54}
55
56// --- 使用例 ---
57
58// 1. デフォルト引数を使用する例 ('now'とシステムデフォルトタイムゾーン)
59$defaultDate = new SimpleDate();
60echo "--- デフォルトの日付 ---\n";
61echo "日付と時刻: " . $defaultDate->getFormattedDate() . "\n";
62echo "タイムゾーン: " . $defaultDate->getTimezoneName() . "\n\n";
63
64// 2. 特定の日付文字列とタイムゾーンを指定する例
65$tokyoTimezone = new DateTimeZone('Asia/Tokyo');
66$specificDate = new SimpleDate('2023-10-27 10:30:00', $tokyoTimezone);
67echo "--- 特定の日付 (東京タイムゾーン) ---\n";
68echo "日付と時刻: " . $specificDate->getFormattedDate() . "\n";
69echo "タイムゾーン: " . $specificDate->getTimezoneName() . "\n\n";
70
71// 3. 日付文字列のみを指定し、タイムゾーンはデフォルトを使用する例
72$futureDate = new SimpleDate('+1 day'); // 明日の日付
73echo "--- 明日の日付 (システムデフォルトタイムゾーン) ---\n";
74echo "日付と時刻: " . $futureDate->getFormattedDate() . "\n";
75echo "タイムゾーン: " . $futureDate->getTimezoneName() . "\n";
76
77?>

PHPのDateTimeクラスの__constructメソッドは、日付と時刻を扱うオブジェクトを初期化するために使用されます。このメソッドは、第一引数に日付と時刻を表す文字列（例: 'now', '2023-10-27 10:30:00'）、第二引数にオプションでタイムゾーンを指定するDateTimeZoneオブジェクトを受け取ります。引数を指定しない場合、デフォルトで現在の日時とPHPの設定に基づいたタイムゾーンが適用されます。コンストラクタであるため、直接の戻り値はありませんが、このメソッドが呼び出されることで初期化されたDateTimeインスタンスが生成されます。

PHP 8で導入された「コンストラクタプロパティプロモーション」は、コンストラクタの引数を、同時にそのクラスのプロパティとして宣言できる便利な機能です。これにより、プロパティの宣言とコンストラクタ内での代入処理をより簡潔に記述できるようになります。

提供されたサンプルコードでは、このDateTime::__constructメソッドとコンストラクタプロパティプロモーションを組み合わせています。SimpleDateクラスのコンストラクタで、引数$datetimeStringと$timezoneをprivateプロパティとして宣言・昇格させています。これらの昇格されたプロパティは、コンストラクタの本体内でnew DateTime()の引数として利用され、内部の$dateプロパティにDateTimeオブジェクトを格納します。この設計により、クラスが受け取った日付文字列とタイムゾーンの情報を、外部からアクセスできない形で保持しつつ、内部でDateTimeオブジェクトとして処理できるようになります。

Copy
1<?php
2
3// PHP 8 で導入された厳密な型チェックを有効にします。
4declare(strict_types=1);
5
6/**
7 * DateTime クラスを継承したカスタムの日付時刻クラス。
8 * このクラスは、親クラスである DateTime の機能を利用しつつ、
9 * 独自の拡張や振る舞いを加えることができます。
10 */
11class MyCustomDateTime extends DateTime
12{
13    /**
14     * MyCustomDateTime クラスのコンストラクタ。
15     * 新しい MyCustomDateTime オブジェクトを作成し、親クラスである DateTime の初期化を行います。
16     *
17     * @param string $datetime 日付と時刻を表す文字列。デフォルトは 'now'。
18     *                         DateTime::createFromFormat() で解析可能な形式である必要があります。
19     * @param ?DateTimeZone $timezone タイムゾーンオブジェクト。デフォルトは null で、
20     *                                 PHP の現在のデフォルトタイムゾーンが使用されます。
21     */
22    public function __construct(string $datetime = 'now', ?DateTimeZone $timezone = null)
23    {
24        // parent::__construct() を呼び出して、親クラス (DateTime) のコンストラクタを実行します。
25        // これにより、DateTime オブジェクトとしての基本的な日付時刻の解析と初期化が行われます。
26        // 継承されたクラスのコンストラクタでは、通常このように親のコンストラクタを呼び出すことで、
27        // 親クラスが持つべき初期状態を正しく設定します。
28        parent::__construct($datetime, $timezone);
29
30        // 必要に応じて、MyCustomDateTime クラス独自の追加の初期化処理をここに記述できます。
31        // 例: echo "MyCustomDateTime オブジェクトが作成されました: " . $this->format('Y-m-d H:i:s') . "\n";
32    }
33
34    /**
35     * このカスタム日付オブジェクトの現在の日時を、特定のフォーマットで取得します。
36     *
37     * @return string フォーマットされた日時文字列 (例: 2023-10-27 15:30:00 Asia/Tokyo)
38     */
39    public function getFormattedDateTimeWithTimezone(): string
40    {
41        return $this->format('Y-m-d H:i:s e'); // 'e' はタイムゾーン識別子を表示
42    }
43}
44
45// --- サンプルコードの実行例 ---
46
47try {
48    // 1. 引数なしで MyCustomDateTime オブジェクトを作成 (デフォルトで 'now' と現在のタイムゾーンを使用)
49    // 親の DateTime コンストラクタが内部で 'now' を処理し、現在の時刻で初期化します。
50    $currentDateTime = new MyCustomDateTime();
51    echo "現在のMyCustomDateTime: " . $currentDateTime->getFormattedDateTimeWithTimezone() . "\n";
52
53    // 2. 特定の日時文字列を指定して MyCustomDateTime オブジェクトを作成
54    // 親の DateTime コンストラクタが指定された文字列を解析して初期化します。
55    $specificDate = new MyCustomDateTime('2024-07-20 10:00:00');
56    echo "特定の日付のMyCustomDateTime: " . $specificDate->getFormattedDateTimeWithTimezone() . "\n";
57
58    // 3. 特定の日時とタイムゾーンを指定して MyCustomDateTime オブジェクトを作成
59    // DateTimeZone オブジェクトを作成し、親のコンストラクタに渡します。
60    $londonTimeZone = new DateTimeZone('Europe/London');
61    $londonDateTime = new MyCustomDateTime('2024-07-20 10:00:00', $londonTimeZone);
62    echo "ロンドン時刻のMyCustomDateTime: " . $londonDateTime->getFormattedDateTimeWithTimezone() . "\n";
63
64    // 4. 不正な日付文字列を渡した場合 (DateTime::__construct は例外をスローします)
65    // このようなケースでは、try-catch ブロックで例外を捕捉することが重要です。
66    // $invalidDateTime = new MyCustomDateTime('これは日付ではありません');
67    // echo "不正な日付: " . $invalidDateTime->getFormattedDateTimeWithTimezone() . "\n";
68
69} catch (Exception $e) {
70    // DateTime::__construct で発生した例外（例: 日付文字列の解析失敗）を捕捉します。
71    echo "エラーが発生しました: " . $e->getMessage() . "\n";
72}

このPHPコードは、PHPに標準で備わる日付時刻を扱うDateTimeクラスを継承し、MyCustomDateTimeという独自のクラスを定義する例を示しています。__constructは、このMyCustomDateTimeクラスの新しいオブジェクトを作成する際に自動的に実行される特別なメソッド、つまりコンストラクタです。このメソッドは、string $datetimeと?DateTimeZone $timezoneという二つの引数を持ちます。$datetimeは初期化する日付と時刻を表す文字列で、指定がなければ現在の時刻（'now'）が使われます。$timezoneはタイムゾーンを指定するオブジェクトで、指定がなければPHPのデフォルトタイムゾーンが適用されます。

コンストラクタ内部のparent::__construct($datetime, $timezone);は、親クラスであるDateTimeのコンストラクタを呼び出しています。これにより、MyCustomDateTimeオブジェクトが生成される際に、DateTimeオブジェクトとしての基本的な日付時刻の解析と初期化が確実に行われます。継承元のクラスが持つ初期化処理を正しく引き継ぐため、子クラスのコンストラクタではparent::__construct()を呼び出すのが一般的です。コンストラクタはオブジェクトの生成と初期化を行うため、特定の値を戻り値として返しません。

コードの実行例では、引数なしで現在の時刻のオブジェクトを作成したり、特定の日時やタイムゾーンを指定してオブジェクトを初期化する柔軟な使い方が示されています。また、日付文字列の形式が不正な場合には例外が発生するため、try-catch文を使ってエラーを適切に処理する重要性も合わせて学べます。