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

Copy
1<?php
2
3// DOMAttr::__construct メソッドの使用例
4
5// 1. 新しい DOMDocument オブジェクトを作成します。
6//    これはXMLやHTMLドキュメント全体を表現するオブジェクトです。
7$dom = new DOMDocument('1.0', 'UTF-8');
8$dom->formatOutput = true; // 生成されるXMLを見やすく整形します
9
10// 2. DOMElement オブジェクト（HTMLタグのような要素）を作成します。
11//    ここでは例として 'div' 要素を作成しています。
12$element = $dom->createElement('div');
13
14// 3. DOMAttr クラスのコンストラクタを使って新しい属性を作成します。
15//    __construct メソッドは、第一引数に属性名、第二引数（オプション）に属性値を指定します。
16//    この行が DOMAttr::__construct メソッドの直接的な利用例です。
17$attributeName = 'id';
18$attributeValue = 'myUniqueDiv';
19$attr = new DOMAttr($attributeName, $attributeValue);
20
21// 4. 作成した属性ノードを 'div' 要素に追加します。
22//    これにより、'div' 要素に 'id="myUniqueDiv"' という属性が付与されます。
23$element->setAttributeNode($attr);
24
25// 5. 'div' 要素をドキュメントのルートに追加します。
26$dom->appendChild($element);
27
28// 6. 完成したXML/HTML構造を文字列として出力します。
29//    期待される出力は、<div id="myUniqueDiv"></div> のような形式です。
30echo $dom->saveXML();
31
32?>

PHP 8のDOMAttr::__constructメソッドは、XMLやHTMLドキュメント内で要素に付与する属性をプログラムで作成するためのコンストラクタです。このメソッドは新しいDOMAttrオブジェクトを初期化し、属性名とその属性値を設定します。

第一引数にはstring $nameとして、作成したい属性の名前を文字列で指定します。例えば、HTMLのidやclassなどがこれに該当します。第二引数にはstring $valueとして、その属性に設定する値を文字列で指定しますが、この引数は省略可能であり、省略された場合は属性値が空文字列として初期化されます。

このメソッドはコンストラクタであるため、呼び出し元に特定の値を戻り値として返しませんが、代わりに指定された属性名と属性値で初期化された新しいDOMAttrオブジェクトが生成されます。

サンプルコードでは、$attr = new DOMAttr($attributeName, $attributeValue); の行で、idという属性名とmyUniqueDivという属性値を持つDOMAttrオブジェクトが作成されています。作成されたDOMAttrオブジェクトは、その後DOMElementオブジェクト（例: div要素）にsetAttributeNodeメソッドで追加することで、実際の要素に属性を付与するために利用されます。これにより、動的にid="myUniqueDiv"のような属性を持つHTML/XML要素を構築することが可能になります。

Copy
1<?php
2
3/**
4 * HtmlAttribute クラスは、HTML要素の属性を表します。
5 * PHP 8 のコンストラクタプロパティプロモーションを使用して、
6 * コンストラクタ引数を直接クラスのプロパティとして定義します。
7 *
8 * DOMAttr クラスのコンストラクタに似た引数 (name, value) を持ちますが、
9 * こちらはユーザー定義クラスでプロパティプロモーションの概念を説明するためのものです。
10 */
11class HtmlAttribute
12{
13    /**
14     * コンストラクタでプロパティを宣言し、初期化します。
15     * PHP 8 では、引数にアクセス修飾子 (public, protected, private) を付けることで、
16     * 自動的に同名のプロパティが作成され、引数の値で初期化されます。
17     * これにより、冗長なプロパティ宣言とコンストラクタ内の代入が不要になります。
18     *
19     * @param string $name 属性の名前（例: "id", "class"）
20     * @param string $value 属性の値（例: "main-content", "btn btn-primary"）。デフォルトは空文字列。
21     */
22    public function __construct(
23        private string $name,  // 'name' プロパティとして定義
24        private string $value = "" // 'value' プロパティとして定義（デフォルト値付き）
25    ) {
26        // コンストラクタの本体は、追加のロジックがない場合は空で構いません。
27        // ここでバリデーションなどを行うことも可能です。
28    }
29
30    /**
31     * 属性の名前を取得します。
32     *
33     * @return string
34     */
35    public function getName(): string
36    {
37        return $this->name;
38    }
39
40    /**
41     * 属性の値を取得します。
42     *
43     * @return string
44     */
45    public function getValue(): string
46    {
47        return $this->value;
48    }
49
50    /**
51     * オブジェクトを文字列に変換する際の挙動を定義します。
52     * 例: "id=\"my-element\""
53     *
54     * @return string
55     */
56    public function __toString(): string
57    {
58        return "{$this->name}=\"{$this->value}\"";
59    }
60}
61
62// --- HtmlAttribute クラスの使用例 ---
63
64// 1. name と value を指定してインスタンスを作成
65$idAttribute = new HtmlAttribute("id", "main-content");
66
67echo "--- PHP 8 Constructor Property Promotion の例 ---" . PHP_EOL;
68echo "属性1: " . $idAttribute . PHP_EOL;
69echo "  名前 (getName()): " . $idAttribute->getName() . PHP_EOL;
70echo "  値 (getValue()): " . $idAttribute->getValue() . PHP_EOL;
71
72echo PHP_EOL;
73
74// 2. value を省略してインスタンスを作成 (デフォルト値が使用される)
75$disabledAttribute = new HtmlAttribute("disabled");
76
77echo "属性2: " . $disabledAttribute . PHP_EOL;
78echo "  名前 (getName()): " . $disabledAttribute->getName() . PHP_EOL;
79echo "  値 (getValue()): " . $disabledAttribute->getValue() . PHP_EOL; // デフォルトの空文字列が出力される
80
81?>

PHPの__constructメソッドは、クラスから新しいオブジェクトを作成する際に自動的に呼び出される特別なメソッドです。このメソッドはオブジェクトの初期設定を行う役割を持ち、プロパティに初期値を設定したり、オブジェクトが機能するために必要な準備を行ったりします。

PHP 8で導入された「コンストラクタプロパティプロモーション」は、この__constructメソッドの記述をより簡潔にするための機能です。従来のPHPでは、クラスプロパティを宣言し、その後コンストラクタ内で引数の値をそのプロパティに代入する手間がありましたが、プロパティプロモーションを使用すると、コンストラクタの引数に直接アクセス修飾子（privateなど）を付けるだけで、同名のプロパティが自動的に宣言され、引数の値で初期化されます。

サンプルコードのHtmlAttributeクラスでは、HTML要素の属性（例えばid="main-content"）を表しています。このクラスの__constructメソッドは、private string $nameとprivate string $value = ""という引数で定義されています。$nameは属性の名前を、$valueは属性の値をそれぞれ受け取ります。$valueにはデフォルト値として空文字列が設定されているため、属性値が不要な場合は引数を省略できます。

このようにプロパティプロモーションを活用することで、冗長なコードを削減し、クラス定義をより読みやすく、保守しやすくすることが可能です。__constructメソッド自体は、オブジェクトを初期化する特別な役割のため、直接的な戻り値はありません。