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

Copy
1<?php
2
3/**
4 * DOMProcessingInstructionクラスのコンストラクタを使用して、
5 * 新しい処理命令ノードを作成し、XMLドキュメントに追加するサンプルコードです。
6 */
7
8// 1. 新しいDOMDocumentオブジェクトを作成します。
9//    これはXMLドキュメント全体を表します。
10$dom = new DOMDocument('1.0', 'UTF-8');
11
12// 2. DOMProcessingInstructionクラスのコンストラクタを呼び出してインスタンスを生成します。
13//    第1引数($name)に処理命令のターゲット名、
14//    第2引数($value)にその値を指定します。
15$pi = new DOMProcessingInstruction(
16    'xml-stylesheet',
17    'href="style.css" type="text/css"'
18);
19
20// 3. 作成した処理命令ノードをDOMドキュメントに追加します。
21$dom->appendChild($pi);
22
23// 4. XMLのルート要素も作成して追加し、完全なXML文書とします。
24$root = $dom->createElement('root');
25$dom->appendChild($root);
26
27// 5. 生成されたXMLの内容を出力します。
28//    見やすくするために出力を整形します。
29$dom->formatOutput = true;
30echo $dom->saveXML();
31
32?>

DOMProcessingInstructionクラスのコンストラクタは、XML文書内で特定のアプリケーションに指示を伝えるための「処理命令ノード」を新しく作成する際に使用されます。これは、クラスのインスタンスを生成するための特別なメソッドです。

このコンストラクタは2つの引数を取ります。第一引数の$nameには、処理命令のターゲットとなる名前を文字列で指定します。これは、どのアプリケーションに対する指示なのかを識別するためのものです。サンプルコードでは、XMLにスタイルシートを適用する指示であるxml-stylesheetが指定されています。第二引数の$valueには、指示の具体的な内容を文字列で指定します。この引数は省略することも可能です。サンプルコードでは、適用するスタイルシートの場所と種類を示すhref="style.css" type="text/css"が値として渡されています。

このメソッド自体に直接的な戻り値はありませんが、呼び出すとDOMProcessingInstructionクラスの新しいオブジェクトが生成されます。サンプルコードでは、このコンストラクタで作成された処理命令ノードのオブジェクトを$piという変数に代入し、後からappendChildメソッドでXMLドキュメント全体を表すオブジェクトに追加しています。

Copy
1<?php
2
3// DOMDocument オブジェクトは、XMLドキュメント全体を表すために使用します。
4$doc = new DOMDocument('1.0', 'UTF-8');
5
6// 出力されるXMLを見やすくするために整形します。
7$doc->formatOutput = true;
8
9// DOMProcessingInstruction クラスのコンストラクタを使用して、
10// 新しい処理命令ノード (<?xml-stylesheet ... ?>) のインスタンスを生成します。
11// 第1引数 ($name): 処理命令のターゲット名 (例: 'xml-stylesheet')
12// 第2引数 ($value): 処理命令のデータ (例: 'type="text/css" href="style.css"')
13$pi = new DOMProcessingInstruction(
14    'xml-stylesheet',
15    'type="text/css" href="style.css"'
16);
17
18// 作成した処理命令ノードをドキュメントに追加します。
19$doc->appendChild($pi);
20
21// XMLのルート要素を作成して追加します。
22$root = $doc->createElement('root');
23$doc->appendChild($root);
24
25// 最終的に生成されたXMLドキュメントを文字列として出力します。
26echo $doc->saveXML();
27
28/*
29出力結果:
30<?xml version="1.0" encoding="UTF-8"?>
31<?xml-stylesheet type="text/css" href="style.css"?>
32<root/>
33*/
34

このサンプルコードは、PHPのDOM拡張機能を使ってXMLドキュメントをプログラムで生成する手順を示しています。中心となるのは、XMLの処理命令を追加するためのDOMProcessingInstructionクラスのコンストラクタの利用です。

new DOMProcessingInstruction()は、XMLの処理命令ノード（<? ... ?>という形式の部分）の新しいインスタンスを生成するためのコンストラクタです。コンストラクタは、オブジェクトを初期化するための特別なメソッドで、newキーワードと共に呼び出されます。

このコンストラクタは2つの引数を取ります。第1引数$nameには、処理命令のターゲット名となる文字列を指定します。コード例では'xml-stylesheet'が指定されており、この命令がXMLスタイルシートに関するものであることを示します。第2引数$valueには、命令の具体的な内容となる文字列を指定します。ここでは'type="text/css" href="style.css"'が渡されています。この引数は省略することも可能です。

このコンストラクタは戻り値を返しませんが、DOMProcessingInstructionの新しいオブジェクトを生成します。生成されたオブジェクトは変数$piに代入され、appendChildメソッドによってドキュメントに追加された後、saveXMLメソッドでXML全体が出力されます。