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

Copy
1<?php
2
3/**
4 * DOMDocument のコンストラクタと property promotion の例
5 */
6class MyDOMDocument extends DOMDocument
7{
8    /**
9     * MyDOMDocument constructor.
10     *
11     * @param string $version  XML version. Defaults to '1.0'.
12     * @param string $encoding XML encoding. Defaults to ''.
13     */
14    public function __construct(
15        private string $version = '1.0',
16        private string $encoding = ''
17    ) {
18        parent::__construct($version, $encoding);
19    }
20
21    /**
22     * バージョンを返す
23     *
24     * @return string
25     */
26    public function getVersion(): string
27    {
28        return $this->version;
29    }
30
31    /**
32     * エンコーディングを返す
33     *
34     * @return string
35     */
36    public function getEncoding(): string
37    {
38        return $this->encoding;
39    }
40}
41
42// 使用例
43$myDom = new MyDOMDocument('1.0', 'UTF-8');
44
45// バージョンとエンコーディングの確認
46echo "Version: " . $myDom->getVersion() . PHP_EOL;
47echo "Encoding: " . $myDom->getEncoding() . PHP_EOL;

PHP 8における DOMDocument クラスのコンストラクタ __construct の使用例です。このコンストラクタは、新しい DOMDocument オブジェクトを生成する際に呼び出されます。

引数として $version と $encoding を受け取ります。 $version はXMLのバージョンを指定する文字列で、デフォルト値は '1.0' です。 $encoding はXMLのエンコーディングを指定する文字列で、デフォルト値は空文字列 '' です。これらの引数は省略可能で、省略した場合はデフォルト値が使用されます。

この例では、MyDOMDocument クラスを DOMDocument クラスから継承し、コンストラクタ内で property promotion を使用しています。Property promotion を使用することで、コンストラクタの引数として渡された $version と $encoding の値を、クラスのprivateプロパティとして直接定義できます。これにより、コンストラクタ内でプロパティを別途定義し、値を代入する手間を省くことができます。

parent::__construct($version, $encoding); の部分では、親クラスである DOMDocument のコンストラクタを呼び出し、バージョンとエンコーディングの設定を引き継いでいます。

getVersion() メソッドと getEncoding() メソッドは、それぞれ $version プロパティと $encoding プロパティの値を返すメソッドです。

サンプルコードの後半では、MyDOMDocument クラスのインスタンスを生成し、getVersion() と getEncoding() メソッドを使用して、設定されたバージョンとエンコーディングの値を出力しています。この例では、バージョンとして '1.0'、エンコーディングとして 'UTF-8' を指定しています。

Copy
1<?php
2
3/**
4 * DOMDocument のコンストラクタの例
5 */
6try {
7    // UTF-8 エンコーディングの DOMDocument を作成
8    $dom = new DOMDocument('1.0', 'UTF-8');
9
10    // ルート要素を作成
11    $root = $dom->createElement('root');
12    $dom->appendChild($root);
13
14    // 子要素を追加
15    $child = $dom->createElement('child', 'Hello, World!');
16    $root->appendChild($child);
17
18    // XML を出力
19    echo $dom->saveXML();
20
21} catch (Exception $e) {
22    echo "エラーが発生しました: " . $e->getMessage() . "\n";
23}

PHPのDOMDocumentクラスのコンストラクタ__constructは、新しいDOMDocumentオブジェクトを生成するために使用します。このコンストラクタは、XMLドキュメントのバージョンとエンコーディングを指定するための引数を受け取ります。

$version引数は、XMLのバージョンを指定します。デフォルト値は '1.0' です。$encoding引数は、ドキュメントの文字エンコーディングを指定します。デフォルトではエンコーディングは指定されません。

サンプルコードでは、まずnew DOMDocument('1.0', 'UTF-8')によって、バージョン1.0、エンコーディングUTF-8のDOMDocumentオブジェクトが作成されます。次に、createElementメソッドでルート要素（この例では'root'）を作成し、appendChildメソッドでドキュメントに追加します。同様に、子要素（'child'）も作成し、ルート要素に追加しています。最後に、saveXMLメソッドを使用して、XMLドキュメントを文字列として出力します。

try-catchブロックを使用することで、DOMDocumentの作成中にエラーが発生した場合でも、エラーメッセージを表示してプログラムが中断しないようにしています。このコンストラクタは戻り値を持ちません。つまり、オブジェクトの生成が成功したかどうかは、例外が発生したかどうかで判断します。DOMDocumentオブジェクトを初期化し、XMLドキュメントの操作を開始するための基本的な手順を示す例です。