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

Copy
1<?php
2
3/**
4 * PHP 8.0で導入された「コンストラクタプロパティプロモーション」のサンプルです。
5 * DOMText::__construct()のように、コンストラクタでデータを受け取るクラスを模倣しています。
6 */
7class TextNode
8{
9    /**
10     * コンストラクタの引数に可視性(public)を宣言することで、
11     * プロパティの宣言と、コンストラクタ内での値の代入を同時に行います。
12     * これにより、クラスの記述が非常に簡潔になります。
13     *
14     * @param string $data このノードが保持するテキストデータ
15     */
16    public function __construct(
17        public readonly string $data = ""
18    ) {
19        // プロパティの宣言 `public readonly string $data;` や
20        // 代入処理 `$this->data = $data;` は不要です。
21        // readonly修飾子(PHP 8.1+)により、このプロパティは初期化後に変更できなくなります。
22    }
23}
24
25// "Hello, PHP 8!" というテキストデータを持つTextNodeインスタンスを生成します。
26$node = new TextNode("Hello, PHP 8!");
27
28// publicプロパティなので、直接アクセスして値を出力できます。
29echo $node->data . PHP_EOL;
30
31// 以下のコードはエラーになります。
32// `readonly`プロパティは一度初期化されると再代入できないためです。
33// $node->data = "New value"; // Fatal error: Uncaught Error: Cannot modify readonly property TextNode::$data

DOMText::__constructメソッドは、テキストデータを保持する新しいDOMTextオブジェクトを生成するためのコンストラクタです。このメソッドは、引数としてノードに設定したい文字列データ（string $data）を1つ受け取ります。例えば、new DOMText("こんにちは")と記述すると、「こんにちは」というテキストを持つノードが作成されます。引数を省略した場合は、デフォルト値として空の文字列が設定されたノードが生成されます。コンストラクタはオブジェクトの初期化を目的とするため、特定の値を返す戻り値はありません。

サンプルコードは、この仕組みをPHP 8.0で導入された「コンストラクタプロパティプロモーション」という機能を使って模倣したものです。この機能を利用すると、コンストラクタの引数にpublicのような可視性を宣言するだけで、クラスのプロパティ定義と、引数の値をプロパティに代入する処理を同時に行うことができます。これにより、従来必要だった定型的な記述が不要になり、コードが非常に簡潔になります。さらに、サンプルではPHP 8.1のreadonly修飾子も使われており、一度設定したプロパティの値を後から変更できないようにして、より安全なプログラムを実現しています。

Copy
1<?php
2
3/**
4 * DOMText::__construct の使用例と、DOMツリーにおけるノードの親子関係を示すコード
5 *
6 * システムエンジニアを目指す初心者の方向けに、DOMTextクラスのコンストラクタの基本的な使い方と、
7 * DOMツリーにおける要素とテキストノードの親子関係を理解できるように作成されています。
8 */
9function createDomWithTextNode(): void
10{
11    // 1. 新しい DOMDocument オブジェクトを作成します。
12    //    これはXMLやHTMLドキュメント全体のコンテナとなります。
13    //    '1.0' はXMLのバージョン、'UTF-8' はエンコーディングを指定します。
14    $dom = new DOMDocument('1.0', 'UTF-8');
15
16    // 出力されるXMLを人間が読みやすいように整形します。
17    $dom->formatOutput = true;
18
19    // 2. ルート要素（例: <root>）を作成し、DOMDocumentに追加します。
20    //    これはドキュメントの最も外側の要素になります。
21    $rootElement = $dom->createElement('root');
22    $dom->appendChild($rootElement);
23
24    // 3. 親となる要素（例: <message>）を作成します。
25    //    この要素の中にテキストノードが配置されます。
26    $parentElement = $dom->createElement('message');
27
28    // 4. DOMText::__construct を使用してテキストノードを作成します。
29    //    引数として、ノードに含めたいテキストコンテンツを文字列で直接渡します。
30    //    これにより、指定されたテキストを持つDOMTextオブジェクトが構築されます。
31    $textNode = new DOMText('Hello, system engineer beginner!');
32
33    // 5. 作成したテキストノードを親要素の子として追加します。
34    //    この操作により、<message>要素がDOMTextノードの「親」となり、
35    //    テキストノードがその子としてDOMツリーに組み込まれます。
36    $parentElement->appendChild($textNode);
37
38    // 6. 親要素をルート要素の子として追加します。
39    //    これにより、<root><message>...</message></root> の構造が完成します。
40    $rootElement->appendChild($parentElement);
41
42    // 7. 生成されたXML構造を文字列として出力します。
43    echo "--- 生成されたXML構造 ---\n";
44    echo $dom->saveXML();
45    echo "--------------------------";
46}
47
48// 上記の関数を実行して、DOMツリーを構築し、その結果を出力します。
49createDomWithTextNode();
50

PHPのDOMText::__constructメソッドは、XMLやHTMLドキュメント内でテキスト部分を表現するDOMTextオブジェクトを新しく作成する際に使用されるコンストラクタです。このメソッドは、引数としてstring $dataを受け取ります。この$dataには、作成したいテキストノードに含める実際の文字列コンテンツを指定します。例えば、new DOMText('コンテンツ')と記述することで、「コンテンツ」という文字列を内容とするDOMTextオブジェクトが構築されます。このコンストラクタは、新しいDOMTextオブジェクトを初期化する役割を持ち、特定の戻り値はありません。

サンプルコードでは、DOMDocumentでドキュメント全体を作成した後、createElementメソッドで<root>や<message>といった要素ノードを生成しています。そして、DOMText::__constructを用いて「Hello, system engineer beginner!」というテキストコンテンツを持つDOMTextオブジェクトを直接作成しています。このテキストノードは、$parentElement->appendChild($textNode)という操作によって、<message>要素の子として追加されます。この追加により、<message>要素が親となり、その中にテキストノードが配置されるというDOMツリー上の明確な親子関係が構築されます。最終的に、生成されるXML構造は<root><message>Hello, system engineer beginner!</message></root>のようになり、テキストノードがどのように要素内に組み込まれるかを示しています。