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

Copy
1<?php
2
3/**
4 * DOMDocumentFragment::__construct() の使用例。
5 *
6 * DOMDocumentFragment は、複数のノードを一時的に保持し、
7 * それらを一度に DOMDocument に追加するための軽量なコンテナです。
8 * これにより、DOM操作のパフォーマンスを向上させることができます。
9 *
10 * システムエンジニアを目指す初心者向けに、基本的なインスタンス化と使用方法を示します。
11 */
12
13// 1. 新しい DOMDocument を作成します。
14//    これは、最終的にノードを追加する対象となるドキュメントです。
15$dom = new DOMDocument('1.0', 'UTF-8');
16$dom->formatOutput = true; // 出力を整形して読みやすくします
17
18// ドキュメントのルート要素を作成し、DOM に追加します。
19$rootElement = $dom->createElement('container');
20$dom->appendChild($rootElement);
21
22// 2. DOMDocumentFragment のインスタンスを作成します。
23//    __construct メソッドは引数なしで呼び出されます。
24//    このフラグメントは、まだDOMツリーの一部ではありません。
25$fragment = new DOMDocumentFragment();
26
27// 3. いくつかの要素を作成し、それらを DOMDocumentFragment に追加します。
28//    フラグメントに追加されたノードは、まだメインの $dom ツリーにはありません。
29$paragraph1 = $dom->createElement('p', 'これは最初の段落です。');
30$fragment->appendChild($paragraph1);
31
32$paragraph2 = $dom->createElement('p', 'これは ');
33$boldText = $dom->createElement('b', '太字');
34$paragraph2->appendChild($boldText);
35$paragraph2->appendChild($dom->createTextNode(' のテキストを含む2番目の段落です。'));
36$fragment->appendChild($paragraph2);
37
38// 4. DOMDocumentFragment 全体をメインの DOMDocument のルート要素に追加します。
39//    フラグメント内のすべてのノードが、$rootElement の子として移動されます。
40//    この操作は、ノードを一つずつ追加するよりも効率的な場合があります。
41$rootElement->appendChild($fragment);
42
43// 5. 最終的な DOMDocument の内容を出力して確認します。
44echo $dom->saveXML();
45
46?>

DOMDocumentFragmentは、XMLやHTMLのドドキュメント（DOM）を操作する際に利用される、軽量なコンテナ（入れ物）です。複数のノード（要素やテキストなど）を一時的に保持し、それらをまとめて一度にDOMドキュメントに追加することを目的としています。これにより、個々のノードを繰り返し追加するよりも、DOM操作のパフォーマンスを向上させることができます。

DOMDocumentFragment::__constructメソッドは、このDOMDocumentFragmentの新しいインスタンスを生成する際に自動的に呼び出されるコンストラクタです。このメソッドは初期化処理を行うもので、特別な引数を必要としません。また、特定の値を返すこともありません。インスタンスが作成された時点では、まだメインのDOMツリーとは関連付けられていません。

サンプルコードでは、まず新しいDOMDocumentとルート要素を作成します。次にnew DOMDocumentFragment()により、引数なしでDOMDocumentFragmentのインスタンスを生成します。その後、作成した複数の段落ノードを、このフラグメントに順次追加していきます。この段階では、これらのノードはメインのDOMDocumentにはまだ含まれていません。最後に$rootElement->appendChild($fragment)とすることで、フラグメント内にまとめていたすべてのノードが、一度にメインのDOMDocumentのルート要素の子として効率的に追加されます。これは、DOMツリーへの変更回数を減らし、処理を最適化するための一般的な手法です。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ユーザー情報を表すクラス
7 *
8 * PHP 8.0 で導入された「コンストラクタプロパティプロモーション」のサンプルです。
9 * この機能を使うと、コンストラクタの引数でプロパティの宣言と初期化を同時に行えます。
10 *
11 * 従来の書き方では、クラス本体でプロパティを宣言し、
12 * コンストラクタ内で `$this->name = $name;` のように代入する必要がありましたが、
13 * その記述が不要になり、コードが非常に簡潔になります。
14 */
15class User
16{
17    /**
18     * コンストラクタ
19     *
20     * 引数に可視性修飾子(public, protected, private)を付けるだけで、
21     * 同名のプロパティが自動的に宣言され、引数の値が代入されます。
22     *
23     * @param int $id ユーザーID (初期化後に変更不可)
24     * @param string $name ユーザー名 (初期化後に変更不可)
25     * @param string $email メールアドレス (外部から変更可能)
26     */
27    public function __construct(
28        public readonly int $id,
29        public readonly string $name,
30        public string $email,
31    ) {
32        // コンストラクタの本体は空でも、プロパティの初期化は自動で行われます。
33        // ここにバリデーションなどの追加ロジックを記述することも可能です。
34    }
35
36    /**
37     * ユーザー情報を表示する
38     */
39    public function printProfile(): void
40    {
41        echo "ID: " . $this->id . PHP_EOL;
42        echo "Name: " . $this->name . PHP_EOL;
43        echo "Email: " . $this->email . PHP_EOL;
44    }
45}
46
47// コンストラクタプロパティプロモーションを使ってインスタンスを生成します。
48$user = new User(1, 'Taro Yamada', 'taro.yamada@example.com');
49
50// プロフィールを表示します。
51$user->printProfile();
52
53echo PHP_EOL;
54
55// public なプロパティは外部から値を変更できます。
56$user->email = 'new.email@example.com';
57echo "メールアドレスが更新されました。" . PHP_EOL;
58$user->printProfile();
59
60// PHP 8.1 で導入された readonly プロパティは、一度初期化されると再代入できません。
61// 以下の行のコメントを外すと、エラーが発生します。
62// $user->name = 'Jiro Suzuki'; // Fatal error: Uncaught Error: Cannot modify readonly property User::$name
63

PHPの__constructメソッドは、クラスから新しいオブジェクト（インスタンス）を作成する際に自動的に呼び出される特別なメソッドです。このメソッドは、オブジェクトの初期設定や、必要な値をプロパティに代入する役割を担います。__constructメソッド自体は特定の値を戻すことがなく、常にvoid型として扱われます。

PHP 8で導入された「コンストラクタプロパティプロモーション」は、__constructメソッドの記述をより簡潔にするための機能です。従来のPHPでは、クラス本体でプロパティを宣言し、さらにコンストラクタ内でそのプロパティに引数の値を代入する、という二段階の記述が必要でした。しかし、この新機能を利用すると、コンストラクタの引数にpublic、protected、privateといった可視性修飾子を直接付与するだけで、プロパティの宣言と初期化を同時に行うことができます。

サンプルコードのUserクラスでは、public readonly int $idのように記述することで、idという名前のpublicかつ読み取り専用のint型プロパティが自動的に作成され、インスタンス生成時に渡された値が直接そのプロパティに代入されます。これにより、コードの記述量が減り、クラスの定義が非常に分かりやすくなります。また、PHP 8.1から利用できるようになったreadonly修飾子を使うと、一度初期化されたプロパティの値を後から変更できないように制限できます。このように、__constructメソッドの引数が、オブジェクトのプロパティとして機能する点がこの機能の大きな特徴です。