【PHP8.x】DOMProcessingInstruction::textContentプロパティの使い方

Copy
1<?php
2
3/**
4 * DOMProcessingInstructionのtextContentプロパティの使用例を示します。
5 *
6 * XMLドキュメントに含まれる処理命令(Processing Instruction)を検出し、
7 * その内容をtextContentプロパティを使って取得・表示します。
8 */
9function showProcessingInstructionContent(): void
10{
11    // 処理命令 <?xml-stylesheet ... ?> を含むXML文字列を定義します。
12    $xmlString = <<<XML
13<?xml version="1.0" encoding="UTF-8"?>
14<?xml-stylesheet href="style.css" type="text/css"?>
15<root>
16  <element>Some text</element>
17</root>
18XML;
19
20    // DOMDocumentオブジェクトを生成します。
21    $doc = new DOMDocument();
22
23    // XML文字列を読み込み、DOMツリーを構築します。
24    $doc->loadXML($xmlString);
25
26    // ドキュメントのすべての子ノードを順番に確認します。
27    foreach ($doc->childNodes as $node) {
28        // ノードの種類が処理命令（Processing Instruction）であるかを確認します。
29        // 例: <?xml-stylesheet ... ?>
30        if ($node instanceof DOMProcessingInstruction) {
31            // 処理命令のターゲット名（例: 'xml-stylesheet'）を取得します。
32            $target = $node->target;
33
34            // 処理命令の内容（ターゲット名に続く文字列）をtextContentプロパティで取得します。
35            // この例では 'href="style.css" type="text/css"' が取得されます。
36            $textContent = $node->textContent;
37
38            echo "処理命令が見つかりました。" . PHP_EOL;
39            echo "ターゲット (target): " . $target . PHP_EOL;
40            echo "内容 (textContent): " . $textContent . PHP_EOL;
41        }
42    }
43}
44
45// 関数を実行します。
46showProcessingInstructionContent();
47
48?>

PHPのDOMProcessingInstructionクラスに属するtextContentプロパティは、XMLドキュメント内の処理命令（Processing Instruction）の内容を取得するために使用します。処理命令とは、<?と?>で囲まれた、アプリケーションに特定の指示を与えるための記述です。

サンプルコードでは、まずDOMDocumentクラスを使ってXML文字列を解析し、プログラムが扱えるオブジェクト構造に変換しています。次に、ドキュメント内の各ノードを順番に確認し、そのノードが処理命令（DOMProcessingInstructionオブジェクト）であるかをinstanceof演算子で判定します。

処理命令が見つかると、textContentプロパティにアクセスしてその内容を取得します。このプロパティは引数を取らず、戻り値として処理命令の内容を文字列（string）で返します。内容が存在しない場合はnullを返すことがあります。サンプルコードの<?xml-stylesheet href="style.css" type="text/css"?>という処理命令の場合、textContentはターゲット名であるxml-stylesheetを除いた、href="style.css" type="text/css"という文字列を取得します。このように、textContentプロパティは、処理命令のターゲット名に続く具体的な指示内容を取り出す際に役立ちます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMProcessingInstruction::textContent プロパティの使用例です。
7 *
8 * この関数は、XML文字列内の処理命令ノード(PI)を検索し、
9 * その内容 (データ部分) を `textContent` プロパティで取得・更新する方法を示します。
10 */
11function demonstrateDomPiTextContent(): void
12{
13    // 処理命令 `<?php-app ...?>` を含むXML文字列を準備
14    $xmlString = <<<XML
15<?xml version="1.0" encoding="UTF-8"?>
16<root>
17  <config>
18    <?php-app version="1.0" mode="production"?>
19  </config>
20  <data>
21    <item>Apple</item>
22  </data>
23</root>
24XML;
25
26    // DOMDocumentオブジェクトを生成し、XMLを読み込む
27    $dom = new DOMDocument();
28    $dom->loadXML($xmlString);
29
30    // XPathを使ってターゲットが 'php-app' の処理命令ノードを検索する
31    $xpath = new DOMXPath($dom);
32    $nodeList = $xpath->query('//processing-instruction("php-app")');
33
34    // 発見したノード(DOMProcessingInstruction)を処理する
35    if ($nodeList && $nodeList->length > 0) {
36        /** @var DOMProcessingInstruction $piNode */
37        $piNode = $nodeList->item(0);
38
39        echo "処理命令のターゲット: " . $piNode->target . PHP_EOL;
40
41        // textContentプロパティで処理命令のデータ部分を取得して表示
42        echo "元のtextContent: " . $piNode->textContent . PHP_EOL;
43
44        // textContentプロパティに新しい値を代入してデータを更新
45        $piNode->textContent = 'version="2.0" mode="development"';
46
47        echo "更新後のtextContent: " . $piNode->textContent . PHP_EOL;
48        echo "---" . PHP_EOL;
49    }
50
51    // 変更が反映されたXMLドキュメント全体を出力
52    $dom->formatOutput = true; // 出力を読みやすく整形する
53    echo "変更後のXML全体:" . PHP_EOL;
54    echo $dom->saveXML();
55}
56
57// 関数を実行して結果を表示
58demonstrateDomPiTextContent();
59
60?>

PHPのDOMProcessingInstruction::textContentは、XMLの処理命令ノード（Processing Instruction, PI）が持つデータ部分のテキスト内容を取得したり、新しく設定したりするためのプロパティです。処理命令とは、<?target data?>という形式で記述され、XMLを処理するアプリケーションに特定の指示を与えるためのものです。

このプロパティにアクセスすると、処理命令の「ターゲット」部分（例：<?php-app ...?>におけるphp-app）を除いた、「データ」部分（例：version="1.0" mode="production"）を文字列として取得できます。戻り値はデータ部分の文字列ですが、状況によってはnullを返す場合もあります。逆に、このプロパティに新しい文字列を代入すると、その処理命令のデータ部分を簡単に書き換えることができます。

サンプルコードでは、まずXML文字列を読み込み、XPathを使って<?php-app ...?>という処理命令ノードを探しています。そして、見つかったノードのtextContentプロパティを参照して元のデータ部分を表示し、次に新しい文字列を代入して内容を更新しています。最後に、更新後のXML全体を出力することで、処理命令のデータが書き換わっていることを確認できます。このようにtextContentプロパティは、処理命令の具体的な指示内容をプログラムで動的に読み書きする際に役立ちます。