【PHP8.x】Deprecated::__construct()メソッドの使い方

Copy
1<?php
2
3/**
4 * PHP 8 で導入されたコンストラクタプロパティプロモーションの例です。
5 * これにより、コンストラクタの引数を直接クラスのプロパティとして宣言し、初期化できます。
6 */
7class Product
8{
9    /**
10     * コンストラクタプロパティプロモーションを使用して、
11     * $name (商品名) と $price (価格) をプロパティとして宣言し、初期化します。
12     * public, protected, private のいずれかの可視性修飾子が必要です。
13     *
14     * @param string $name  商品の名前
15     * @param float  $price 商品の価格
16     */
17    public function __construct(
18        public string $name,
19        public float $price
20    ) {
21        // プロパティプロモーションを使用する場合、コンストラクタの本体が空になることがよくあります。
22        // ここに初期化ロジックを追加することも可能です。
23    }
24
25    /**
26     * 商品の詳細情報を取得します。
27     *
28     * @return string 商品名と価格を含む文字列
29     */
30    public function getDetails(): string
31    {
32        return "商品名: {$this->name}, 価格: " . number_format($this->price, 2) . "円";
33    }
34}
35
36// Product クラスのインスタンスを作成します。
37$product1 = new Product('PHP入門書', 2980.50);
38$product2 = new Product('キーボード', 8500.00);
39
40// プロパティに直接アクセスできます。
41echo $product1->getDetails() . PHP_EOL; // 出力: 商品名: PHP入門書, 価格: 2,980.50円
42echo $product2->getDetails() . PHP_EOL; // 出力: 商品名: キーボード, 価格: 8,500.00円
43
44// プロパティは public なので直接読み書き可能です。
45$product1->price = 2500.00;
46echo $product1->getDetails() . PHP_EOL; // 出力: 商品名: PHP入門書, 価格: 2,500.00円
47
48?>

PHPにおける__constructメソッドは、クラスから新しいインスタンス（オブジェクト）が作られる際に自動的に実行される特別なメソッドです。主に、オブジェクトが必要とする初期設定を行うために使用されます。このメソッドは、値を返しません。

PHP 8から導入された「コンストラクタプロパティプロモーション」という機能により、__constructメソッドの引数として、直接クラスのプロパティを宣言し、同時に初期化することが可能になりました。これにより、従来のPHPバージョンで必要だったプロパティの宣言と、コンストラクタ内での引数からプロパティへの代入処理を省略でき、コードをより簡潔に記述できます。

サンプルコードのProductクラスでは、public string $nameやpublic float $priceのように、引数に可視性修飾子（public、protected、privateのいずれか）と型宣言を付加しています。これにより、$nameと$priceが自動的にクラスのプロパティとして宣言され、インスタンス作成時に引数として渡された値で初期化されます。

例えば、new Product('PHP入門書', 2980.50)と記述すると、'PHP入門書'が$nameプロパティに、2980.50が$priceプロパティに直接格納されます。これらのプロパティはpublicで宣言されているため、$product1->nameのようにインスタンスから直接アクセスしたり、値を変更したりできます。getDetailsメソッドは、これらのプロパティの値を組み合わせて整形された文字列を返しています。

Copy
1<?php
2
3/**
4 * プログラミング言語の特定の要素（例：関数やクラス）が
5 * 今後使われなくなる予定であることを示すための、独自のサンプルクラスです。
6 * PHPにおける __construct メソッドの基本的な使い方を理解することを目的とします。
7 *
8 * PHP 8 のコンストラクタプロパティプロモーションを使用しています。
9 */
10class MyDeprecatedFeature
11{
12    /**
13     * MyDeprecatedFeature クラスの新しいインスタンスを生成します。
14     *
15     * これはクラスが作成される際に自動的に呼び出される特別なメソッド（コンストラクタ）です。
16     * 提供されたリファレンス情報にある Deprecated クラスの __construct メソッドの
17     * 引数定義（`string $message = '', string $since = ''`）を参考にしています。
18     *
19     * PHP 8 の新機能である「コンストラクタプロパティプロモーション」により、
20     * 引数をプロパティとして宣言し、同時に初期化することができます。
21     *
22     * @param string $message 非推奨である理由を示すメッセージ。デフォルトは空文字列。
23     * @param string $since   非推奨になった、または非推奨になる予定のバージョン。デフォルトは空文字列。
24     */
25    public function __construct(
26        private string $message = '',
27        private string $since = ''
28    ) {
29        // 引数はすでに private プロパティとして宣言され、初期化されているため、
30        // ここに `$this->message = $message;` といった記述は不要です。
31    }
32
33    /**
34     * この非推奨機能に関する情報を整形して返します。
35     *
36     * @return string 非推奨メッセージとバージョン情報。
37     */
38    public function getInfo(): string
39    {
40        if ($this->message === '' && $this->since === '') {
41            return "この機能に関する非推奨情報は特に指定されていません。";
42        } elseif ($this->message === '') {
43            return "この機能はバージョン {$this->since} で非推奨になります。";
44        } elseif ($this->since === '') {
45            return "非推奨情報: {$this->message}";
46        } else {
47            return "非推奨情報: {$this->message} (バージョン {$this->since} より)";
48        }
49    }
50}
51
52// --- 以下、MyDeprecatedFeature クラスの使用例です ---
53
54// 例1: メッセージとバージョンを両方指定してインスタンスを作成します。
55// このとき、__construct メソッドが自動的に呼び出され、引数がプロパティに設定されます。
56$feature1 = new MyDeprecatedFeature(
57    'この関数は将来のバージョンで削除される予定です。',
58    'PHP 9.0'
59);
60echo "特徴1: " . $feature1->getInfo() . PHP_EOL;
61
62// 例2: メッセージのみを指定してインスタンスを作成します。
63// $since 引数はデフォルト値（空文字列）が適用されます。
64$feature2 = new MyDeprecatedFeature('データベース接続方法はより安全な方法に変更されます。');
65echo "特徴2: " . $feature2->getInfo() . PHP_EOL;
66
67// 例3: 引数を何も指定せずにインスタンスを作成します。
68// 両方の引数にデフォルト値（空文字列）が適用されます。
69$feature3 = new MyDeprecatedFeature();
70echo "特徴3: " . $feature3->getInfo() . PHP_EOL;
71

このサンプルコードは、PHPでクラスのインスタンスが作成される際に自動的に呼び出される特別なメソッド「__construct（コンストラクタ）」の基本的な使い方を示しています。

MyDeprecatedFeatureクラスの__constructメソッドは、非推奨となる機能に関する情報（メッセージとバージョン）を受け取ります。引数$messageは非推奨の理由を説明する文字列、$sinceは非推奨になった、または非推奨になる予定のバージョンを示す文字列です。これらはどちらも省略可能で、省略された場合はデフォルトの空文字列が設定されます。このメソッドは、クラスの初期化を行うため、特定の値を返すことはありません。

PHP 8の新機能である「コンストラクタプロパティプロモーション」を使用しており、引数をprivate string $messageのように宣言することで、同時にクラスのプロパティとして定義され、受け取った値で初期化されます。これにより、コンストラクタ内で改めて$this->message = $message;と書く必要がなくなります。

サンプルコードの実行部分では、MyDeprecatedFeatureクラスのインスタンスを生成する際に、__constructメソッドが自動で呼び出され、渡された引数（またはデフォルト値）がクラス内に保存される様子を確認できます。getInfo()メソッドを通じて、保存された情報がどのように利用されるかを示しています。

Copy
1<?php
2
3/**
4 * このクラスは、PHPにおけるオブジェクトの「構築（construction）」の基本、
5 * 特にコンストラクタ（__constructメソッド）の役割を示します。
6 *
7 * コンストラクタは、クラスの新しいインスタンスが作成される際に
8 * 自動的に呼び出される特別なメソッドです。
9 * オブジェクトの初期状態を設定するために使用されます。
10 *
11 * PHP 8 の内部クラスである Deprecated::__construct メソッドの
12 * 引数シグネチャ（string $message = '', string $since = ''）を参考に、
13 * 一般的なクラスでコンストラクタを定義する例を示します。
14 */
15class MyCustomObject
16{
17    /**
18     * オブジェクトに関連するメッセージを保持します。
19     *
20     * @var string
21     */
22    private string $message;
23
24    /**
25     * オブジェクトの補足情報（例: バージョン、作成日など）を保持します。
26     * Deprecated::__construct の $since 引数を模倣しています。
27     *
28     * @var string
29     */
30    private string $additionalInfo;
31
32    /**
33     * コンストラクタメソッド。
34     * 新しい MyCustomObject のインスタンスが作成される際に自動的に実行されます。
35     * オブジェクトのプロパティを初期化するために使用します。
36     *
37     * @param string $message      オブジェクトの主なメッセージ。デフォルトは空文字列。
38     * @param string $additionalInfo オブジェクトに関する補足情報。デフォルトは空文字列。
39     * @return void 戻り値はありません。
40     */
41    public function __construct(string $message = '', string $additionalInfo = '')
42    {
43        // 引数として渡された値をオブジェクトのプロパティに設定し、初期化します。
44        $this->message = $message;
45        $this->additionalInfo = $additionalInfo;
46
47        echo "MyCustomObject が構築されました。\n";
48        echo "設定されたメッセージ: '" . ($this->message ?: '[デフォルトメッセージ]') . "'\n";
49        echo "設定された補足情報: '" . ($this->additionalInfo ?: '[補足情報なし]') . "'\n";
50    }
51
52    /**
53     * オブジェクトの現在の情報を文字列として返します。
54     *
55     * @return string オブジェクトのメッセージと補足情報を含む文字列。
56     */
57    public function getObjectDetails(): string
58    {
59        return "詳細情報: メッセージ = '{$this->message}', 補足 = '{$this->additionalInfo}'";
60    }
61}
62
63// --- サンプルコードの実行 ---
64
65// 1. 引数なしでオブジェクトを構築する例
66echo "--- オブジェクト1（引数なし）---\n";
67$object1 = new MyCustomObject();
68echo $object1->getObjectDetails() . "\n\n";
69
70// 2. 両方の引数を与えてオブジェクトを構築する例
71echo "--- オブジェクト2（両方の引数あり）---\n";
72$object2 = new MyCustomObject("カスタム設定メッセージ", "初回リリース 1.0");
73echo $object2->getObjectDetails() . "\n\n";
74
75// 3. 最初の引数のみを与えてオブジェクトを構築する例
76echo "--- オブジェクト3（最初の引数のみ）---\n";
77$object3 = new MyCustomObject("別のカスタムメッセージ");
78echo $object3->getObjectDetails() . "\n";

このPHPコードは、オブジェクト指向プログラミングにおける「コンストラクタ」、特に__constructメソッドの役割を示しています。コンストラクタは、クラスから新しいオブジェクト（インスタンス）を作成する際に、自動的に実行される特別なメソッドです。オブジェクトが持つプロパティの初期値を設定するなど、オブジェクトの準備をするために利用されます。

サンプルコードのMyCustomObjectクラスでは、public function __construct(string $message = '', string $additionalInfo = '')としてコンストラクタを定義しています。PHP 8の内部クラスDeprecated::__constructメソッドの引数構成を参考に、$messageと$additionalInfoという二つの文字列型引数を持ちます。これら引数はどちらもデフォルト値が設定されているため、引数なしでもオブジェクトを生成できます。これらの引数で渡された値は、オブジェクト自身の内部プロパティに格納され、そのオブジェクトの初期状態となります。コンストラクタは値を返さないため、戻り値はvoidです。

コードの実行例では、引数なし、全ての引数あり、最初の引数のみありといった様々なパターンでオブジェクトを構築し、コンストラクタがそれぞれの引数に応じてオブジェクトを初期化する様子を確認できます。これにより、オブジェクトがどのように生成され、初期設定されるかの基本が理解できます。

Copy
1<?php
2
3/**
4 * プログラミング言語の専門家が、システムエンジニアを目指す初心者向けに
5 * PHPのトレイトにおけるコンストラクタの基本的な使い方を示すサンプルコードです。
6 *
7 * キーワード: php constructor in trait
8 */
9
10// Trait (トレイト) を定義します。
11// トレイトは、複数のクラスで再利用したいメソッドやプロパティの集合です。
12// トレイトもコンストラクタ (__construct) を持つことができます。
13trait GreetingTrait
14{
15    private string $greetingMessage;
16
17    /**
18     * トレイトのコンストラクタです。
19     *
20     * このトレイトを使用するクラスが自身のコンストラクタを持たない場合、
21     * このトレイトのコンストラクタが、そのクラスのコンストラクタとして自動的に呼び出されます。
22     *
23     * @param string $initialMessage コンストラクタに渡される初期メッセージ
24     */
25    public function __construct(string $initialMessage = "Hello from Trait!")
26    {
27        $this->greetingMessage = $initialMessage;
28        echo "GreetingTrait::__construct が呼び出されました。メッセージ: " . $this->greetingMessage . PHP_EOL;
29    }
30
31    /**
32     * トレイト内で定義された挨拶メッセージを返すメソッドです。
33     *
34     * @return string 挨拶メッセージ
35     */
36    public function getGreeting(): string
37    {
38        return "トレイトのメッセージ: " . $this->greetingMessage;
39    }
40
41    /**
42     * トレイト内のメッセージを使って挨拶を表示するメソッドです。
43     */
44    public function sayHello(): void
45    {
46        echo $this->getGreeting() . PHP_EOL;
47    }
48}
49
50// GreetingTrait を使用するクラスを定義します。
51// このクラスは自身のコンストラクタ (__construct) を持っていません。
52// そのため、GreetingTrait で定義されたコンストラクタが、このクラスのインスタンス化時に自動的に呼び出されます。
53class Greeter
54{
55    use GreetingTrait;
56
57    // クラスは自身のコンストラクタを持たないため、GreetingTraitのコンストラクタが使用されます。
58    // クラスに独自のコンストラクタが定義された場合、そちらが優先され、
59    // トレイトのコンストラクタは自動的に呼び出されなくなります。
60}
61
62// Greeter クラスのインスタンスを作成します。
63// クラスはコンストラクタを持たないため、GreetingTrait のコンストラクタが呼び出されます。
64echo "--- Greeter クラスのインスタンス化 ---" . PHP_EOL;
65$myGreeter = new Greeter("PHPの世界へようこそ！");
66
67// インスタンスのメソッドを呼び出し、トレイトのコンストラクタによって設定された値が利用されていることを確認します。
68$myGreeter->sayHello();

このサンプルコードは、PHPにおける「トレイト」のコンストラクタ（__construct）がどのように機能するかを、システムエンジニアを目指す初心者向けに具体的に示しています。トレイトは、複数のクラスで共通のメソッドやプロパティを再利用するための仕組みです。通常のクラスと同様に、トレイトも__constructメソッドを定義することができます。

__constructは、オブジェクトが生成される際に自動的に呼び出される特別なメソッドで、オブジェクトの初期設定を行うために使用されます。このメソッドはstring $initialMessageのような引数を受け取ることで、オブジェクトの初期状態をカスタマイズできますが、戻り値はありません。

トレイトのコンストラクタの重要な点は、そのトレイトを利用するクラスが自身のコンストラクタを明示的に持たない場合にあります。このとき、トレイトで定義された__constructが、そのクラスのコンストラクタとして自動的に呼び出されます。

サンプルコードでは、GreetingTraitにコンストラクタが定義されており、これを使用するGreeterクラスは独自のコンストラクタを持っていません。そのため、Greeterクラスのインスタンスが作成される際にGreetingTraitのコンストラクタが呼び出され、初期メッセージが設定される様子が確認できます。もしクラスが独自のコンストラクタを持つ場合は、クラス自身のコンストラクタが優先され、トレイトのコンストラクタは自動的に呼び出されない点に注意が必要です。