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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * finfo::__construct のシグネチャを模倣し、
7 * コンストラクタのプロパティ昇格機能を使ってプロパティを初期化するクラス
8 */
9class FileInfoConfig
10{
11    /**
12     * コンストラクタの引数に可視性修飾子 (public) を付けることで、
13     * プロパティの宣言と初期化を同時に行います。
14     * これが「コンストラクタのプロパティ昇格 (Constructor Property Promotion)」です。
15     *
16     * @param int $flags FILEINFO_* 定数のいずれか
17     * @param ?string $magicDatabase magicデータベースファイルへのパス、またはnull
18     */
19    public function __construct(
20        public int $flags = FILEINFO_NONE,
21        public ?string $magicDatabase = null
22    ) {
23        // PHP 8以前では、以下のような記述が必要でした。
24        //
25        // private int $flags;
26        // private ?string $magicDatabase;
27        //
28        // public function __construct(int $flags, ?string $magicDatabase)
29        // {
30        //     $this->flags = $flags;
31        //     $this->magicDatabase = $magicDatabase;
32        // }
33    }
34
35    /**
36     * 設定情報を表示します。
37     */
38    public function display(): void
39    {
40        echo "Flags: " . $this->flags . PHP_EOL;
41        echo "Magic Database: " . ($this->magicDatabase ?? 'N/A') . PHP_EOL;
42    }
43}
44
45// 引数を指定せずにインスタンスを作成（デフォルト値が使用される）
46$config1 = new FileInfoConfig();
47echo "--- Config 1 ---" . PHP_EOL;
48$config1->display();
49
50echo PHP_EOL;
51
52// すべての引数を指定してインスタンスを作成
53$config2 = new FileInfoConfig(FILEINFO_MIME_TYPE, '/usr/share/misc/magic');
54echo "--- Config 2 ---" . PHP_EOL;
55$config2->display();

このPHP 8のサンプルコードは、FileInfoConfigというクラスを定義し、PHP 8の新機能である「コンストラクタのプロパティ昇格」を解説するものです。このクラスは、ファイル情報を扱うfinfoクラスのコンストラクタの仕様を参考に作られています。

__constructメソッドは、newキーワードでクラスのインスタンスを生成する際に自動的に実行される特別なメソッドです。このコードの最大の特徴は、コンストラクタの引数$flagsと$magicDatabaseの前にpublicというキーワードが付いている点です。これがコンストラクタのプロパティ昇格機能であり、プロパティの宣言と、引数で受け取った値による初期化を同時に行います。これにより、従来は別途必要だったプロパティ宣言とコンストラクタ内での代入処理を省略でき、コードが非常に簡潔になります。

引数$flagsは動作を制御する整数値、$magicDatabaseは設定ファイルへのパスを示す文字列またはnullを受け取ります。どちらもデフォルト値が設定されているため、インスタンス生成時に引数を省略できます。コードの後半では、引数を省略してデフォルト値でインスタンスを生成する例と、具体的な値を指定して生成する例を示し、それぞれのプロパティに値が正しく設定されていることを確認しています。