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

Copy
1<?php
2
3/**
4 * Dom\CharacterData::getLineNo() メソッドの使用例を示します。
5 * このメソッドは、DOMノードが元のドキュメントの何行目に位置するかを返します。
6 * Dom\CharacterData は、テキストノード、コメントノード、CDATAセクションノードなどの
7 * 文字列ベースのノードの抽象基底クラスです。
8 */
9function demonstrateDomCharacterDataGetLineNo(): void
10{
11    // DOMDocument オブジェクトを作成します。
12    $dom = new DOMDocument();
13
14    // サンプルとなるXML文字列を定義します。
15    // 各ノードの行番号が明確になるように、意図的に改行を含めています。
16    $xmlString = <<<XML
17<?xml version="1.0" encoding="UTF-8"?>
18<root>
19    <element>
20        これはテキストノードの例です。
21    </element>
22    <!-- これはコメントノードの例です。 -->
23    <data>もっとデータがあります。</data>
24</root>
25XML;
26
27    // XML文字列をDOMDocumentにロードします。
28    // ロードに失敗した場合はエラーメッセージを表示して終了します。
29    if (!$dom->loadXML($xmlString)) {
30        echo "エラー: XMLのロードに失敗しました。\n";
31        return;
32    }
33
34    echo "--- Dom\\CharacterData::getLineNo() サンプル ---\n\n";
35
36    // 1. テキストノードの行番号を取得する例
37    // 'element' タグを持つ要素を取得します。
38    $elements = $dom->getElementsByTagName('element');
39    if ($elements->length > 0) {
40        $element = $elements->item(0);
41        // 'element' 要素の子ノードを走査し、DOMTextノードを見つけます。
42        foreach ($element->childNodes as $childNode) {
43            // DOMText は Dom\CharacterData を継承しています。
44            if ($childNode instanceof DOMText) {
45                // getLineNo() メソッドを呼び出し、ノードの開始行番号を取得します。
46                $lineNumber = $childNode->getLineNo();
47                // nodeValueには前後の空白や改行も含まれる場合があります。
48                echo "テキストノード '{$childNode->nodeValue}' はXMLの {$lineNumber} 行目にあります。\n";
49                break; // 最初のテキストノードを見つけたら処理を終了します。
50            }
51        }
52    } else {
53        echo "要素 '<element>' が見つかりませんでした。\n";
54    }
55
56    echo "\n";
57
58    // 2. コメントノードの行番号を取得する例
59    // DOMXPath を使用して、ドキュメント内のすべてのコメントノードを検索します。
60    $xpath = new DOMXPath($dom);
61    $comments = $xpath->query('//comment()'); // XPathでコメントノードを選択
62    if ($comments->length > 0) {
63        $commentNode = $comments->item(0);
64        // DOMComment も Dom\CharacterData を継承しています。
65        if ($commentNode instanceof DOMComment) {
66            $lineNumber = $commentNode->getLineNo();
67            echo "コメントノード '{$commentNode->nodeValue}' はXMLの {$lineNumber} 行目にあります。\n";
68        }
69    } else {
70        echo "コメントノードが見つかりませんでした。\n";
71    }
72}
73
74// 上記のサンプル関数を実行します。
75demonstrateDomCharacterDataGetLineNo();

PHP 8で提供されるDom\CharacterData::getLineNo()メソッドは、XMLやHTMLなどのDOMドキュメント内で、テキストノードやコメントノードのように文字データを持つノードが、元のドキュメントの何行目から始まるかを取得するために使用されます。このメソッドは引数を必要とせず、ノードの開始行番号を示す整数（int）を戻り値として返します。

サンプルコードでは、まずXML文字列を作成し、それをDOMDocumentクラスに読み込ませています。その後、読み込んだドキュメントから具体的なテキストノードとコメントノードを検索して取得します。これらのノードはDom\CharacterDataを継承しているため、共通してgetLineNo()メソッドを利用できます。このメソッドを呼び出すことで、それぞれのノードが元のXML文字列上で何行目に位置しているかという情報が正確に取得され、結果として出力されます。これにより、DOMツリー内の要素が元のファイル上のどこにあるのかを特定することが可能になり、ドキュメントの解析やデバッグ作業の際に非常に役立ちます。

Copy
1<?php
2
3/**
4 * Dom\CharacterData::getLineNo() と例外処理における Exception::getLine() の使用例を示します。
5 * システムエンジニアを目指す初心者向けに、DOMノードがソースドキュメントの何行目に定義されているか、
6 * および例外が発生したコードの行番号を理解するためのサンプルです。
7 */
8function demonstrateDomLineNumbers(): void
9{
10    echo "--- Dom\\CharacterData::getLineNo() のデモンストレーション ---" . PHP_EOL;
11
12    // XML文字列を定義します。各ノードの行番号が分かりやすいように記述しています。
13    // PHPのヒアドキュメント構文 (<<<XML ... XML;) を使用しています。
14    $xmlString = <<<XML
15<?xml version="1.0" encoding="UTF-8"?>
16<root>
17    <item id="1">
18        テキストデータ <!-- この行(4行目)にDOMTextノードが存在 -->
19    </item>
20    <item id="2">
21        CDATAセクション
22        <![CDATA[この中のデータはパースされません。]]> <!-- この行(8行目)にDOMCdataSectionノードが存在 -->
23        これはCDATAセクション後のテキストです。
24    </item>
25    <!-- コメントノード --> <!-- この行(11行目)にDOMCommentノードが存在 -->
26</root>
27XML;
28
29    $dom = new DOMDocument();
30    // XML文字列をDOMDocumentオブジェクトにロードします。
31    // loadXML() はデフォルトで行番号情報を保持します。
32    $dom->loadXML($xmlString);
33
34    // DOMXPath を使用して CharacterData を継承するノードを検索します。
35    // Dom\CharacterData は抽象クラスで、DOMText, DOMComment, DOMCdataSection などが継承します。
36    $xpath = new DOMXPath($dom);
37
38    // 1. DOMText ノードの行番号を取得する例
39    // XPath '//item[@id="1"]/text()' は、idが"1"の<item>要素の直下にあるテキストノードを選択します。
40    $textNodes = $xpath->query('//item[@id="1"]/text()');
41    if ($textNodes->length > 0) {
42        /** @var DOMText $textNode */
43        // テキストデータ「テキストデータ」はXMLの4行目に存在します。
44        $textNode = $textNodes->item(0); 
45        echo "DOMText ノードのデータ: '" . trim($textNode->data) . "'" . PHP_EOL;
46        echo "  - Dom\\CharacterData::getLineNo(): " . $textNode->getLineNo() . " (期待値: 4)" . PHP_EOL;
47    } else {
48        echo "DOMText ノードが見つかりませんでした。" . PHP_EOL;
49    }
50
51    // 2. DOMCdataSection ノードの行番号を取得する例
52    // XPath '//item[@id="2"]/node()[self::CDATASection]' は、idが"2"の<item>要素の子ノードの中から
53    // CDATASectionタイプのノードを選択します。
54    $cdataNodes = $xpath->query('//item[@id="2"]/node()[self::CDATASection]');
55    if ($cdataNodes->length > 0) {
56        /** @var DOMCdataSection $cdataNode */
57        // CDATAセクションはXMLの8行目に存在します。
58        $cdataNode = $cdataNodes->item(0);
59        echo "DOMCdataSection ノードのデータ: '" . $cdataNode->data . "'" . PHP_EOL;
60        echo "  - Dom\\CharacterData::getLineNo(): " . $cdataNode->getLineNo() . " (期待値: 8)" . PHP_EOL;
61    } else {
62        echo "DOMCdataSection ノードが見つかりませんでした。" . PHP_EOL;
63    }
64
65    // 3. DOMComment ノードの行番号を取得する例
66    // XPath '//comment()' は、ドキュメント内の全てのコメントノードを選択します。
67    $commentNodes = $xpath->query('//comment()');
68    if ($commentNodes->length > 0) {
69        /** @var DOMComment $commentNode */
70        // コメントノードはXMLの11行目に存在します。
71        $commentNode = $commentNodes->item(0);
72        echo "DOMComment ノードのデータ: '" . trim($commentNode->data) . "'" . PHP_EOL;
73        echo "  - Dom\\CharacterData::getLineNo(): " . $commentNode->getLineNo() . " (期待値: 11)" . PHP_EOL;
74    } else {
75        echo "DOMComment ノードが見つかりませんでした。" . PHP_EOL;
76    }
77
78
79    echo PHP_EOL . "--- 例外処理 (Exception::getLine()) のデモンストレーション ---" . PHP_EOL;
80
81    // 意図的に例外を発生させ、その発生行を Exception::getLine() で取得する例です。
82    try {
83        // ここで不正なDOM操作を行い、DOMException を発生させます。
84        // DOMDocument オブジェクトを別の DOMDocument オブジェクトの子ノードとして追加することはできません。
85        $dom->appendChild(new DOMDocument()); // この行で例外が発生します（スクリプト内の行番号）。
86        echo "この行は実行されません。" . PHP_EOL; // 例外が発生すると、この行はスキップされます。
87    } catch (DOMException $e) {
88        echo "DOMException が捕捉されました。" . PHP_EOL;
89        echo "  - 例外メッセージ: " . $e->getMessage() . PHP_EOL;
90        // Exception::getLine() は、例外がスローされたPHPコードの**ファイル内の行番号**を返します。
91        echo "  - 例外発生行 (Exception::getLine()): " . $e->getLine() . PHP_EOL;
92    } catch (Exception $e) {
93        // DOMException 以外の一般的な例外も捕捉できるようにします。
94        echo "一般的な Exception が捕捉されました。" . PHP_EOL;
95        echo "  - 例外メッセージ: " . $e->getMessage() . PHP_EOL;
96        echo "  - 例外発生行 (Exception::getLine()): " . $e->getLine() . PHP_EOL;
97    }
98}
99
100// デモンストレーション関数を実行します。
101demonstrateDomLineNumbers();

このサンプルコードは、PHPでXMLドキュメントの構造を扱う際に、特定のノードが元のドキュメントの何行目に位置するかを調べるDom\CharacterData::getLineNo()メソッドと、プログラム実行中に発生した例外がPHPコードの何行目で起きたかを特定するException::getLine()メソッドの使い方を示しています。

Dom\CharacterData::getLineNo()は、XMLなどのドキュメントをPHPのDOMで扱う際に、各要素やテキスト、コメントなどが元のファイルで何行目に書かれていたかを知るためのメソッドです。このメソッドは引数を取らず、整数（int）でその行番号を返します。例えば、XMLファイル中の特定のテキストデータ、コメント、CDATAセクションといった文字データを扱うノード（DOMText、DOMComment、DOMCdataSectionなど）が、元のXML文字列の何行目に定義されているかを正確に把握できます。これは、XML構造のデバッグやエラー位置の特定に役立ちます。

一方、Exception::getLine()は、PHPプログラムの実行中にエラーが発生し、例外がスローされた場合に、その例外がPHPコードの何行目で発生したかを示すメソッドです。こちらも引数はなく、整数（int）で例外が発生したスクリプト内の行番号を返します。この情報は、プログラムのデバッグ時や、どのコード箇所で問題が起きたかを特定する際に非常に重要です。このサンプルコードでは、意図的に不正なDOM操作を行い、例外発生行を特定する例を示しています。

それぞれのメソッドは異なる「行番号」を示しており、Dom\CharacterData::getLineNo()は元のデータソースの行番号、Exception::getLine()はPHPスクリプト自体の行番号を指します。