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

Copy
1<?php
2
3/**
4 * DOMNode::getLineNo() メソッドの使用例
5 *
6 * このスクリプトは、XML ドキュメントを解析し、
7 * 特定のノードが元の XML ソースの何行目にあるかを取得する方法を示します。
8 * システムエンジニアを目指す初心者向けに、DOM の基本的な操作と行番号取得を解説します。
9 */
10
11// 処理対象となる XML ドキュメントを文字列として定義します。
12// ヒアドキュメント構文 (<<<XML ... XML;) を使用して、複数行の文字列を記述しています。
13$xmlString = <<<XML
14<?xml version="1.0" encoding="UTF-8"?>
15<products>
16    <product id="101">
17        <name>Laptop</name>
18        <price>1200</price>
19    </product>
20    <product id="102">
21        <name>Mouse</name>
22        <price>25</price>
23    </product>
24</products>
25XML;
26
27// DOMDocument オブジェクトを作成します。
28// これは XML ドキュメント全体を表現するためのクラスです。
29$dom = new DOMDocument();
30
31// XML 文字列を DOMDocument オブジェクトにロードします。
32// loadXML() メソッドは成功した場合 true、失敗した場合 false を返します。
33// 失敗時のエラーハンドリングを追加して、初心者にも分かりやすくしています。
34if (!$dom->loadXML($xmlString)) {
35    echo "エラー: XML ドキュメントのロードに失敗しました。\n";
36    exit(1); // スクリプトを終了します
37}
38
39// ドキュメントから特定のタグ名を持つノード群を取得します。
40// ここでは最初の <name> タグのノードを探します。
41$nameNodes = $dom->getElementsByTagName('name');
42
43// 取得したノードリストが空でないか確認します。
44if ($nameNodes->length > 0) {
45    // 最初の <name> ノードを取得します。
46    // getElementsByTagName() は DOMNodeList を返すので、item(0) で最初の要素にアクセスします。
47    $firstNode = $nameNodes->item(0);
48
49    // DOMNode::getLineNo() メソッドを使用して、このノードがXMLソースの何行目にあるかを取得します。
50    // 戻り値は整数 (int) です。
51    $lineNumber = $firstNode->getLineNo();
52
53    echo "--- ノード情報 ---\n";
54    echo "取得したノード名: " . $firstNode->nodeName . "\n";
55    echo "取得したノードの内容: " . $firstNode->nodeValue . "\n";
56    echo "このノードが元のXMLソースで出現する行番号: " . $lineNumber . "行目\n";
57
58    // 別のノードの例として、2番目の <name> ノードも取得してみます。
59    if ($nameNodes->length > 1) {
60        $secondNode = $nameNodes->item(1);
61        $secondLineNumber = $secondNode->getLineNo();
62        echo "\n--- 別のノード情報 ---\n";
63        echo "取得したノード名: " . $secondNode->nodeName . "\n";
64        echo "取得したノードの内容: " . $secondNode->nodeValue . "\n";
65        echo "このノードが元のXMLソースで出現する行番号: " . $secondLineNumber . "行目\n";
66    }
67
68} else {
69    echo "エラー: 'name' タグを持つノードが見つかりませんでした。\n";
70}
71
72?>

PHPのDOMNode::getLineNo()メソッドは、XMLドキュメントを解析する際に、特定の要素（ノード）が元のXMLソースファイルの何行目に記述されているかを取得するための便利な機能です。引数はなく、戻り値として整数の行番号（int）を返します。

このサンプルコードでは、まず定義されたXML文字列をDOMDocumentクラスにロードし、XML全体をPHPで扱えるオブジェクトとして準備しています。次に、getElementsByTagName('name')メソッドを使って、すべての<name>タグのノードを取得しています。

取得したノードリストの中から最初の<name>ノードを選び、そのDOMNodeオブジェクトに対してgetLineNo()メソッドを呼び出すことで、XMLソース内でのそのノードの開始行番号を取得しています。例えば、<name>Laptop</name>というノードがXMLの特定の行にあれば、その行番号が数値で返されます。

このように、getLineNo()を使うことで、XML文書の構造をプログラムで理解し、必要に応じて元のソースのどの部分に関連する情報なのかを特定できるため、エラー報告やデバッグ、さらにはXML変換ツールなどで役立ちます。二番目の<name>ノードでも同様に行番号を取得し、異なるノードの行番号がそれぞれ正しく取得できることを示しています。

Copy
1<?php
2
3/**
4 * DOMNode::getLineNo() メソッドの使用例をデモンストレーションします。
5 *
6 * この関数は、XML文字列を解析し、DOMノードが元のドキュメントの何行目に位置するかを表示します。
7 * XMLの読み込みエラーが発生した場合の基本的なエラーハンドリングも含まれています。
8 */
9function demonstrateDomNodeGetLineNo(): void
10{
11    // 複数行にわたるサンプルXML文字列
12    $xmlString = <<<XML
13<?xml version="1.0" encoding="UTF-8"?>
14<books>
15    <book id="bk101">
16        <title>Everyday Italian</title>
17        <author>Giada De Laurentiis</author>
18    </book>
19    <book id="bk102">
20        <title>Harry Potter</title>
21        <author>J.K. Rowling</author>
22    </book>
23</books>
24XML;
25
26    $dom = new DOMDocument();
27    // libxmlのエラーを内部で処理し、警告が出力されないように設定します。
28    // これにより、loadXMLが失敗した場合に返り値で判断し、エラーメッセージを正確に取得できます。
29    libxml_use_internal_errors(true);
30
31    if (!$dom->loadXML($xmlString)) {
32        // XMLの読み込みに失敗した場合のエラーハンドリング
33        echo "Error loading XML:\n";
34        foreach (libxml_get_errors() as $error) {
35            // libxml_get_errors() は DOMError オブジェクトの配列を返します。
36            echo "  " . $error->message . " at line " . $error->line . "\n";
37        }
38        libxml_clear_errors(); // 処理したエラーをクリアします。
39        return;
40    }
41
42    libxml_clear_errors(); // 読み込みが成功した場合もエラーリストをクリアします。
43    libxml_use_internal_errors(false); // 内部エラーハンドリングを元の状態に戻します。
44
45    // すべての 'book' 要素を取得します。
46    $books = $dom->getElementsByTagName('book');
47
48    echo "--- Book Node Line Numbers ---\n";
49    foreach ($books as $book) {
50        // DOMNode::getLineNo() は、そのノードが元のXMLドキュメントで宣言された行番号を返します。
51        echo "Book (id='" . $book->getAttribute('id') . "') is on line: " . $book->getLineNo() . "\n";
52
53        // 'title' 子要素の行番号も取得してみます。
54        $titleNode = $book->getElementsByTagName('title')->item(0);
55        if ($titleNode instanceof DOMElement) {
56            echo "  Title '" . $titleNode->textContent . "' is on line: " . $titleNode->getLineNo() . "\n";
57        }
58    }
59
60    // 特定のテキストノードの行番号も取得できます。
61    // 例えば、最初の本のタイトルのテキストノード
62    $firstTitleTextNode = $books->item(0)->getElementsByTagName('title')->item(0)->firstChild;
63    if ($firstTitleTextNode instanceof DOMText) {
64        echo "\n--- Text Node Line Number ---\n";
65        echo "Text node for first title '" . $firstTitleTextNode->nodeValue . "' is on line: " . $firstTitleTextNode->getLineNo() . "\n";
66    }
67}
68
69// 関数を実行してデモンストレーションを開始します。
70demonstrateDomNodeGetLineNo();

PHPのDOMNode::getLineNo()メソッドは、XMLやHTMLドキュメント内の特定のノードが、元のドキュメントの何行目に位置するかを整数（int）で取得するために使用されます。このメソッドは引数を持ちません。

サンプルコードでは、まず複数行にわたるXML文字列をDOMDocumentクラスで読み込みます。この際、libxml_use_internal_errors(true)を設定することで、XML解析エラーが発生してもPHPの警告を出さずに内部で処理し、エラーの詳細をlibxml_get_errors()で取得して表示する堅牢なエラーハンドリングを実装しています。これは、XMLの処理において非常に重要です。

XMLの読み込みが成功すると、getElementsByTagName('book')で「book」タグの要素群を取得します。それぞれの「book」要素に対してgetLineNo()を呼び出すことで、その要素がXMLドキュメントの何行目にあるかを表示します。さらに、「title」要素や、その中のテキストノードに対しても同様にgetLineNo()を使用し、より詳細な行番号情報を取得できることを示しています。このように、開発者はこのメソッドを用いて、XML構造と元のドキュメント上の位置を関連付けてデバッグやコンテンツ処理を行うことができます。