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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * PHP 8 のコンストラクタプロモーションの例を示すクラス。
7 * DOMComment クラスのコンストラクタを参考にしています。
8 */
9class MyComment
10{
11    /**
12     * コンストラクタプロモーションを利用したコンストラクタ。
13     *
14     * コンストラクタの引数に `public readonly` のような可視性修飾子を付けることで、
15     * プロパティの宣言と、コンストラクタ内での値の代入を同時に行うことができます。
16     * これにより、コードがより簡潔になります。
17     *
18     * @param public readonly ?string $data コメントのテキストデータ。nullも許容される。
19     */
20    public function __construct(
21        public readonly ?string $data = null
22    ) {
23    }
24}
25
26// 1. テキストデータを指定してインスタンスを生成する
27$comment1 = new MyComment('これはサンプルコメントです。');
28echo 'コメント1のデータ: ';
29var_dump($comment1->data); // -> string(35) "これはサンプルコメントです。"
30
31echo PHP_EOL;
32
33// 2. 引数を省略してインスタンスを生成する（デフォルト値の null が使用される）
34$comment2 = new MyComment();
35echo 'コメント2のデータ: ';
36var_dump($comment2->data); // -> NULL
37

DOMComment::__constructは、HTMLやXMLドキュメント内で使われるコメントノード（例: <!-- コメント -->）を新しく作成するためのコンストラクタメソッドです。

このメソッドは、コメントの内容となる文字列を引数 $data として受け取ります。引数の型は ?string となっており、文字列または null を指定できます。また、= null が指定されているため、引数を省略した場合はデフォルト値として null が自動的に設定され、中身が空のコメントが作成されます。コンストラクタのため、特定の戻り値はありません。

サンプルコードでは、この動作を模したMyCommentクラスを定義し、PHP 8の新機能「コンストラクタプロモーション」を説明しています。public function __construct(public readonly ?string $data = null) という書き方により、引数にpublicやreadonlyといった修飾子を付けるだけで、プロパティの宣言と初期値の代入を同時に行うことができます。これにより、従来よりもコードを簡潔に記述できます。

実行例では、文字列を渡してインスタンスを生成した場合、dataプロパティにその文字列が設定されます。一方、引数を省略した場合は、dataプロパティにはデフォルト値のnullが設定されることが確認できます。

Copy
1<?php declare(strict_types=1);
2
3/**
4 * DOMCommentクラスのコンストラクタを模倣し、
5 * PHP 8.0の「コンストラクタプロパティプロモーション」機能を示すサンプルクラスです。
6 */
7class MyComment
8{
9    /**
10     * コンストラクタ。
11     *
12     * 引数の前に `public` をつけることで、プロパティの宣言と
13     * コンストラクタ内での値の代入を同時に行っています。
14     *
15     * 従来の書き方での
16     *   public ?string $data;
17     *   public function __construct(?string $data = null) {
18     *       $this->data = $data;
19     *   }
20     * と同じ意味になります。
21     *
22     * @param ?string $data コメントとして保持するテキストデータ。デフォルトは null。
23     */
24    public function __construct(
25        public ?string $data = null
26    ) {
27        // コンストラクタプロパティプロモーションを使用しているため、
28        // このブロック内にコードを記述する必要はありません。
29    }
30}
31
32// 1. テキストデータを指定してインスタンスを生成します。
33$comment1 = new MyComment('これはサンプルコメントです。');
34echo '生成されたコメント1のデータ: ';
35var_dump($comment1->data);
36
37echo PHP_EOL;
38
39// 2. 引数を省略してインスタンスを生成します（デフォルト値の null が使用されます）。
40$comment2 = new MyComment();
41echo '生成されたコメント2のデータ: ';
42var_dump($comment2->data);

DOMComment::__constructは、HTMLやXMLドキュメント内にコメントノードを作成するためのコンストラクタです。new DOMComment()のように、クラスから新しいインスタンス（オブジェクト）を生成する際に自動的に呼び出されます。

引数$dataには、コメントの内容となるテキストデータを文字列で渡します。この引数は省略することができ、その場合はデフォルト値としてnullが設定されます。引数の型が?stringとされているのは、文字列またはnullのどちらも受け取れることを示しています。

サンプルコードでは、このコンストラクタの挙動を模倣しつつ、PHP 8.0で導入された「コンストラクタプロパティプロモーション」という便利な機能を紹介しています。これは、コンストラクタの引数にpublicなどの可視性修飾子を付けるだけで、プロパティの宣言と初期化を同時に行える構文です。この機能により、従来よりもコードを簡潔に記述できます。

実行例では、具体的な文字列を渡した場合と、引数を省略してnullが設定された場合の両方を確認できます。なお、コンストラクタはインスタンスの初期化を目的とする特殊なメソッドであるため、特定の値を返すことはなく、戻り値はありません。