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

Copy
1<?php
2
3/**
4 * DOMCdataSection::after() を使用して、
5 * 既存のCDATAセクションの後に新しいノードを追加するサンプルです。
6 *
7 * 「aftercare」というキーワードにちなみ、元のメッセージ（CDATA）の後に
8 * 補足情報（アフターケア）を追加する処理を実装します。
9 */
10function demonstrateCdataAftercare(): void
11{
12    // 1. DOMDocumentオブジェクトを準備
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    // 出力されるXMLを読みやすく整形する
15    $dom->formatOutput = true;
16
17    // 2. XMLの基本構造を作成
18    $root = $dom->createElement('log');
19    $entry = $dom->createElement('entry');
20    $root->appendChild($entry);
21    $dom->appendChild($root);
22
23    // 3. 元となるメッセージをCDATAセクションとして作成
24    $mainMessage = $dom->createCDATASection(
25        'ユーザー登録が完了しました。アカウントIDは <user-id-123> です。'
26    );
27    $entry->appendChild($mainMessage);
28
29    // 4. アフターケアとして追加するノード（要素とテキスト）を作成
30    $noteElement = $dom->createElement('note', 'ご利用ありがとうございます。');
31    $followUpText = $dom->createTextNode('続けてプロフィールの設定を行ってください。');
32
33    // 5. CDATAセクション($mainMessage)の直後に、作成したノードを追加
34    // DOMCdataSection::after() は、指定したノードの後に複数のノードや文字列を挿入できます。
35    $mainMessage->after($noteElement, $followUpText);
36
37    // 6. 結果のXMLを出力
38    echo $dom->saveXML();
39}
40
41demonstrateCdataAftercare();

DOMCdataSection::after()メソッドは、特定のCDATAセクションの直後に、新しいノード（要素やテキストなど）や文字列を追加するための機能です。このサンプルコードでは、XML文書内の既存のCDATAセクションの後に、補足情報となる要素とテキストを追加する処理を示しています。

最初にDOMDocumentオブジェクトを準備し、<log>と<entry>要素を持つXMLの骨格を作成します。次に、createCDATASection()を使って、XML内でそのまま表示したい文字列を含むCDATAセクション（$mainMessage）を生成し、<entry>要素内に追加します。

続いて、createElement()とcreateTextNode()を使い、後から追加する補足情報用の要素ノードとテキストノードを作成します。

このコードの中心となるのが$mainMessage->after()の呼び出し部分です。このメソッドを実行することで、$mainMessageで表されるCDATAセクションの直後の位置に、引数で指定した要素ノードとテキストノードが順番に挿入されます。引数には、DOMNodeオブジェクトや文字列を複数渡すことが可能です。メソッドの戻り値はvoidであり、処理を実行するだけで何も値を返しません。

最後にsaveXML()で、ノードが追加された後のXML文書全体を出力しています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定されたXML内のリハビリ計画(rehab)を管理するクラスです。
7 * DOMCdataSection::after() を使用して、計画の後に完了報告を追加します。
8 */
9class RehabManager
10{
11    /**
12     * リハビリ計画に完了報告を追加し、更新されたXMLを返します。
13     *
14     * @param string $xmlString 患者のリハビリ計画を含むXML文字列
15     * @return string|false 更新されたXML文字列、または失敗時にfalse
16     */
17    public function addCompletionReport(string $xmlString): string|false
18    {
19        // DOMDocumentオブジェクトを生成し、XMLを読み込みます。
20        $dom = new DOMDocument();
21        // 出力を見やすくするためにフォーマットを有効にします。
22        $dom->formatOutput = true;
23        $dom->preserveWhiteSpace = false;
24
25        // XMLの読み込みエラーをハンドルします。
26        if (!@$dom->loadXML($xmlString)) {
27            return false;
28        }
29
30        // 'rehab_plan' タグを取得し、その子ノードである CDATA セクションを見つけます。
31        // getElementsByTagNameはDOMNodeListを返すため、最初の要素(item(0))を取得します。
32        $rehabPlanElement = $dom->getElementsByTagName('rehab_plan')->item(0);
33        $cdataNode = $rehabPlanElement?->firstChild;
34
35        // CDATAノードが DOMCdataSection のインスタンスであることを確認します。
36        if ($cdataNode instanceof DOMCdataSection) {
37            // DOMCdataSection::after() を使用して、CDATAノードの直後に新しいノードを追加します。
38            // これにより、リハビリ(rehab)計画の後(after)に、その結果が追記されます。
39            $reportElement = $dom->createElement('rehab_report', 'Rehabilitation was successful.');
40            $statusComment = $dom->createComment(' Status: Completed ');
41
42            // 複数のノード（要素とコメント）を一度に挿入します。
43            $cdataNode->after($reportElement, $statusComment);
44        }
45
46        // 更新されたXML文字列を返します。
47        return $dom->saveXML();
48    }
49}
50
51// --- 実行コード ---
52
53// 患者のリハビリ計画を含む初期XMLデータです。
54// <rehab_plan> タグには、特殊文字を含む可能性がある計画詳細を CDATA セクションで記述します。
55$initialXml = <<<XML
56<?xml version="1.0" encoding="UTF-8"?>
57<patient_record>
58  <id>p-789</id>
59  <name>John Doe</name>
60  <rehab_plan><

このPHPサンプルコードは、XMLで記述された患者のリハビリ計画データに、完了報告を追加する方法を示しています。

このコードで中心となるのはDOMCdataSection::after()メソッドです。このメソッドは、特定のCDATAセクション（XML内で特殊文字をそのまま記述するための領域）の直後に、一つまたは複数の新しいノード（XMLの構成要素）を挿入する機能を持っています。

サンプルでは、リハビリ計画（rehab）が記述されたCDATAセクションを取得し、そのafter()メソッドを呼び出しています。引数には、createElementで作成した報告用の要素ノードとcreateCommentで作成したコメントノードを渡しています。これにより、CDATAセクションの直後（after）に、これらのノードが指定した順序で挿入されます。

このメソッドの戻り値はvoidであり、何も返しません。メソッドを呼び出すと、操作対象のXML文書オブジェクト自体が直接変更されます。最終的にsaveXML()によって、変更が加えられたXML文書全体が文字列として出力されます。このようにafter()メソッドは、既存のノードを基準にして、その後ろに新しい要素を簡単に追加したい場合に便利です。