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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ProcessingInstruction::after() を使用して、
7 * 処理命令ノードの後に新しいノードを追加するデモ関数です。
8 *
9 * キーワード「aftercare」にちなんで、
10 * ドキュメント処理の「後」に「ケア」としてコメントや要素を追加するシナリオを想定しています。
11 */
12function demonstrateAftercareWithProcessingInstruction(): void
13{
14    // 1. DOMDocumentオブジェクトを初期化
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    $dom->formatOutput = true; // 出力されるXMLを整形する
17
18    // 2. ルート要素を作成
19    $root = $dom->createElement('root');
20    $dom->appendChild($root);
21
22    // 3. 対象となる処理命令ノードを作成し、ドキュメントに追加
23    // 例: このドキュメントにスタイルシートを適用するという処理命令
24    $processingInstruction = $dom->createProcessingInstruction(
25        'xml-stylesheet',
26        'type="text/css" href="style.css"'
27    );
28    $root->appendChild($processingInstruction);
29
30    // 4. ダミーのコンテンツ要素を追加
31    $content = $dom->createElement('content', 'This is the original content.');
32    $root->appendChild($content);
33
34    // 5. ProcessingInstruction::after() を使用
35    // 処理命令ノード ($processingInstruction) の直後に、
36    // アフターケアとして新しいコメントノードと要素ノードを追加します。
37    // 引数には複数のノードや文字列を渡すことができます。
38    $processingInstruction->after(
39        $dom->createComment(' Aftercare: The process is complete. '),
40        $dom->createElement('aftercare_status', 'OK')
41    );
42
43    // 6. 変更後のXMLを出力
44    echo $dom->saveXML();
45}
46
47// 関数を実行
48demonstrateAftercareWithProcessingInstruction();
49
50?>

Dom\ProcessingInstruction::after()メソッドは、特定の処理命令ノードの直後に、新しいノードを追加するために使用します。

このサンプルコードでは、まずcreateProcessingInstruction()を使い、XML文書にスタイルシートを適用するための処理命令ノード<?xml-stylesheet ... ?>を作成しています。

次に、この処理命令ノードを格納した変数$processingInstructionに対してafter()メソッドを呼び出します。これにより、$processingInstructionのすぐ後ろの位置に新しいノードが挿入されます。

引数には、追加したいノードオブジェクトや文字列をカンマ区切りで複数指定することが可能です。この例では、createComment()で作成したコメントノードと、createElement()で作成した<aftercare_status>要素の2つを渡しています。

このメソッドの戻り値はvoidであり、何も値を返しません。処理はドキュメントの構造に直接反映されます。最終的にsaveXML()で出力されたXMLを見ると、元の処理命令ノードの直後に、指定したコメントと要素が追加されていることが確認できます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Dom\ProcessingInstruction::after() の使用例を示します。
7 *
8 * この関数は、患者のカルテを模したXMLドキュメントを扱います。
9 * 「リハビリが必要」というステータスを示す処理命令ノードを見つけ、
10 * その直後に「リハビリ完了」の診断結果ノードとコメントノードを挿入します。
11 */
12function demonstrateNodeInsertionAfterRehabStatus(): void
13{
14    // 患者のカルテを表すXMLデータ。
15    // `<?patient-status rehab-needed?>` は処理命令ノードです。
16    $xmlString = <<<XML
17    <?xml version="1.0" encoding="UTF-8"?>
18    <patientRecord>
19        <name>Taro Yamada</name>
20        <injury>Leg fracture</injury>
21        <?patient-status rehab-needed?>
22        <notes>Patient requires physical therapy.</notes>
23    </patientRecord>
24    XML;
25
26    // DOMDocumentオブジェクトを作成し、XMLを読み込みます
27    $dom = new DOMDocument();
28    $dom->loadXML($xmlString);
29
30    // 'patient-status' というターゲット名を持つ処理命令ノードを取得します
31    // PHP 8以降、DOMノードは新しい `Dom\*` クラスのインスタンスとして扱われます
32    /** @var Dom\ProcessingInstruction|null $processingInstruction */
33    $processingInstruction = $dom->getElementsByTagName('patient-status')->item(0);
34
35    // 処理命令ノードが存在する場合に処理を実行します
36    if ($processingInstruction) {
37        // 新しく追加する診断結果の要素ノードを作成します
38        $diagnosisElement = $dom->createElement('diagnosis', 'Rehabilitation complete.');
39
40        // 新しく追加するテキストノードを作成します
41        $nextStepText = $dom->createTextNode('Next step: Follow-up check.');
42
43        // 処理命令ノードの直後(`after`)に、新しいノードを複数挿入します
44        $processingInstruction->after($diagnosisElement, $nextStepText);
45    }
46
47    // 結果を見やすく整形してXMLを出力します
48    $dom->formatOutput = true;
49    echo $dom->saveXML();
50}
51
52// 関数を実行します
53demonstrateNodeInsertionAfterRehabStatus();

Dom\ProcessingInstruction::after()は、特定の処理命令ノードの直後に、新しいノード（要素やテキストなど）を挿入するためのメソッドです。

このサンプルコードでは、患者のカルテを模したXMLデータを扱います。XML内には<?patient-status rehab-needed?>という処理命令ノードがあり、「リハビリが必要」という状態を示しています。プログラムはまずこの処理命令ノードを取得します。次に、取得したノードに対してafter()メソッドを呼び出し、その直後に「リハビリ完了」を示す診断結果の要素ノードと、次のステップに関するテキストノードを挿入しています。

引数には、挿入したいDOM\Nodeオブジェクトや文字列をカンマで区切って複数指定できます。文字列を渡した場合は、自動的にテキストノードとして扱われます。このメソッドはDOMの構造を直接変更するため、戻り値はありません（void）。最終的に変更されたXMLを出力すると、元の処理命令ノードの後に新しい情報が正しく追加されていることが確認できます。