【PHP8.x】Dom\ProcessingInstruction::before()メソッドの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Dom\ProcessingInstruction::before() を使用して、
7 * ターゲットノードの前に指定した量のノードを挿入する例です。
8 */
9function demonstrateDomProcessingInstructionBefore(): void
10{
11    // 操作対象となるXML文字列を準備します。
12    // <?xml-stylesheet ... ?> が処理命令(ProcessingInstruction)です。
13    $xmlString = <<<XML
14<?xml version="1.0" encoding="UTF-8"?>
15<items>
16  <?xml-stylesheet type="text/css" href="style.css"?>
17  <item id="1">Apple</item>
18</items>
19XML;
20
21    // DOMDocumentオブジェクトを作成し、XMLを読み込みます。
22    $dom = new DOMDocument();
23    // 出力を見やすくするためにフォーマットを有効にします。
24    $dom->preserveWhiteSpace = false;
25    $dom->formatOutput = true;
26    $dom->loadXML($xmlString);
27
28    // 挿入位置の基準となる処理命令(ProcessingInstruction)ノードを取得します。
29    // この例では、<items>の最初の子要素である <?xml-stylesheet ... ?> をターゲットにします。
30    $targetNode = $dom->getElementsByTagName('items')->item(0)->firstChild;
31
32    // ターゲットが ProcessingInstruction であることを確認します。
33    if ($targetNode instanceof Dom\ProcessingInstruction) {
34        // ターゲットノードの前に追加したい複数のノード(コメントと要素)を作成します。
35        $commentNode = $dom->createComment(' New item added ');
36        $newItemElement = $dom->createElement('item', 'Orange');
37        $newItemElement->setAttribute('id', '2');
38
39        // before()メソッドを使い、ターゲットノードの直前に
40        // 指定した量のノード(この場合は2つ)を一度に挿入します。
41        $targetNode->before($commentNode, $newItemElement);
42    }
43
44    // 変更後のXMLを出力します。
45    echo $dom->saveXML();
46}
47
48// 関数を実行します。
49demonstrateDomProcessingInstructionBefore();
50
51/*
52実行結果の例:
53
54<?xml version="1.0" encoding="UTF-8"?>
55<items>
56  <!-- New item added -->
57  <item id="2">Orange</item>
58  <?xml-stylesheet type="text/css" href="style.css"?>
59  <item id="1">Apple</item>
60</items>
61
62*/

このPHPサンプルコードは、Dom\ProcessingInstruction::before()メソッドを使用して、XML文書内の特定の処理命令ノードの直前に、一つまたは複数の新しいノードを挿入する方法を示します。処理命令ノードとは、サンプルコード内の<?xml-stylesheet ... ?>のように、XMLプロセッサへの指示を記述する部分のことです。

before()メソッドは、このメソッドを呼び出した処理命令ノードを基準点とし、そのすぐ前に引数で指定されたノードを追加します。引数...$nodesは可変長引数であり、Dom\Nodeオブジェクトや文字列をカンマで区切って複数指定できます。これにより、指定した量のノードを一度の操作でまとめて挿入することが可能です。このメソッドはDOMの構造を直接変更するため、処理の結果として値を返すことはなく、戻り値はvoidとなります。

コードの例では、まずXML文字列を読み込んでDOMオブジェクトを生成します。次に、挿入の基準となる<?xml-stylesheet ... ?>ノードを取得します。そして、新しく追加したいコメントノードと要素ノードを作成し、before()メソッドにそれらを渡して挿入を実行します。最終的にsaveXML()で変更後のXMLを出力すると、指定した処理命令の前に新しいノードが追加されていることが確認できます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Dom\ProcessingInstruction::before() の使用例を示します。
7 *
8 * XMLドキュメント内の特定の処理命令(Processing Instruction)ノードを見つけ、
9 * そのノードの直前に新しいノードを挿入する方法を実演します。
10 * これは、ドキュメント内の特定の位置(number)の前(before)に要素を追加する操作にあたります。
11 */
12function demonstrateNodeInsertionBeforeProcessingInstruction(): void
13{
14    // 操作の基になるXML文字列を準備します。
15    // <?php-app ...?> という処理命令が含まれています。
16    $xmlString = <<<XML
17    <?xml version="1.0" encoding="UTF-8"?>
18    <items>
19      <item id="1">Apple</item>
20      <?php-app process="true"?>
21      <item id="2">Banana</item>
22    </items>
23    XML;
24
25    // DOMDocumentオブジェクトをインスタンス化し、XMLを読み込みます。
26    $dom = new DOMDocument();
27    // 整形して出力するために、フォーマット出力を有効にします。
28    $dom->formatOutput = true;
29    $dom->loadXML($xmlString);
30
31    // 'php-app' というターゲット名を持つ処理命令ノードを取得します。
32    // getElementsByTagName() は DOMNodeList を返します。
33    $processingInstructions = $dom->getElementsByTagName('php-app');
34
35    // 最初の処理命令ノードを取得します。
36    // Dom\ProcessingInstruction は Dom\Node の一種です。
37    $targetNode = $processingInstructions->item(0);
38
39    if ($targetNode instanceof Dom\ProcessingInstruction) {
40        echo "--- 変更前のXML ---" . PHP_EOL;
41        echo $dom->saveXML();
42        echo PHP_EOL;
43
44        // ターゲットノードの before() メソッドを呼び出します。
45        // 引数には、挿入したい Dom\Node オブジェクトや文字列を渡すことができます。
46        // ここでは、新しいコメントノードとテキストノード（改行）を挿入します。
47        $newComment = $dom->createComment(' Inserted before the processing instruction ');
48        $targetNode->before($newComment, "\n  ");
49
50        echo "--- 変更後のXML ---" . PHP_EOL;
51        // 変更が適用されたXMLを出力します。
52        echo $dom->saveXML();
53    }
54}
55
56// 作成した関数を実行します。
57demonstrateNodeInsertionBeforeProcessingInstruction();

このPHPサンプルコードは、Dom\ProcessingInstructionクラスが持つbefore()メソッドの具体的な使い方を示します。このメソッドは、XMLドキュメント内にある特定の処理命令ノードの直前に、新しいノード（要素、コメント、テキストなど）を挿入するために使用されます。これは、ドキュメント内の特定の位置の前（before）に要素を追加する操作にあたります。

コードの処理の流れとして、まず<?php-app ...?>という処理命令が含まれたXMLデータをDOMDocumentオブジェクトとして読み込みます。次に、getElementsByTagName()を利用して、操作対象となるphp-appという処理命令ノードを特定し、取得します。

そして、取得した処理命令ノードオブジェクトからbefore()メソッドを呼び出します。このメソッドの引数には、挿入したいDom\Nodeオブジェクトや文字列を複数指定することが可能です。この例では、新しく作成したコメントノードと、整形用の改行を表すテキストノードを渡しています。その結果、指定した処理命令ノードのすぐ手前に、これらの新しいノードが追加されます。このメソッドはドキュメントを直接変更するため、戻り値はありません（void）。

最後に、変更前と変更後のXMLを出力することで、処理命令の前にノードが正しく挿入されたことを視覚的に確認できます。