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

Copy
1<?php
2
3/**
4 * DOMElement::getLineNo() メソッドの使用例を示します。
5 * このメソッドは、DOMDocument にロードされた要素が元のドキュメントの何行目に位置するかを返します。
6 * システムエンジニアを目指す初心者向けに、XML ドキュメントの要素の行番号を取得する基本的な方法を提供します。
7 */
8function demonstrateGetLineNo(): void
9{
10    // 解析対象となるXML文字列を定義します。
11    // 各要素の開始タグが異なる行にあることに注目してください。
12    $xmlString = <<<XML
13<?xml version="1.0" encoding="UTF-8"?>
14<products>
15    <product id="1">
16        <name>Laptop</name>
17        <price>1200.00</price>
18    </product>
19    <product id="2">
20        <name>Mouse</name>
21        <price>25.00</price>
22    </product>
23</products>
24XML;
25
26    // DOMDocument オブジェクトを新しく作成します。
27    $dom = new DOMDocument();
28
29    // XML 文字列を DOMDocument にロードします。
30    // エラーが発生した場合（例：不正なXML形式）、falseを返します。
31    if (!$dom->loadXML($xmlString)) {
32        echo "XMLのロードに失敗しました。\n";
33        return;
34    }
35
36    echo "XMLドキュメントから要素の行番号を取得:\n";
37
38    // ドキュメント内のすべての 'product' 要素を取得します。
39    // DOMNodeList は、取得した要素のコレクションです。
40    $products = $dom->getElementsByTagName('product');
41
42    // 各 'product' 要素を反復処理し、その行番号を出力します。
43    foreach ($products as $product) {
44        // DOMElement の getLineNo() メソッドを呼び出し、要素が元のXMLの何行目にあるかを取得します。
45        // 例えば、最初の <product> タグは4行目、2番目の <product> タグは9行目です。
46        $lineNumber = $product->getLineNo();
47
48        // 'id' 属性の値を取得して、どの商品か識別します。
49        $productId = $product->getAttribute('id');
50
51        echo "  Product ID '{$productId}' は元のドキュメントの {$lineNumber} 行目から始まります。\n";
52
53        // 各商品の子要素（name, price）の行番号も取得してみましょう。
54        $nameElement = $product->getElementsByTagName('name')->item(0);
55        if ($nameElement instanceof DOMElement) {
56            echo "    - Name要素は {$nameElement->getLineNo()} 行目から始まります。\n";
57        }
58
59        $priceElement = $product->getElementsByTagName('price')->item(0);
60        if ($priceElement instanceof DOMElement) {
61            echo "    - Price要素は {$priceElement->getLineNo()} 行目から始まります。\n";
62        }
63    }
64}
65
66// サンプル関数を実行します。
67demonstrateGetLineNo();
68

このPHPのサンプルコードは、XMLドキュメント内の特定の要素が、元のファイルや文字列の何行目に位置するかを調べるDOMElement::getLineNo()メソッドの使い方を実演しています。このメソッドは引数を取らず、要素の開始行番号を整数（int）で返します。

コードではまず、製品情報を含むXML形式の文字列を定義しています。次に、DOMDocumentオブジェクトを作成し、このXML文字列をロードして、プログラムで扱えるように解析しています。XMLのロードに失敗した場合はエラーメッセージを表示し処理を終了します。

XMLが正常にロードされると、getElementsByTagName('product')メソッドを使って、ドキュメント内のすべてのproductタグの要素を取得します。それぞれのproduct要素に対してgetLineNo()メソッドを呼び出すことで、その要素がXML文字列の何行目から開始しているかを取得し、表示しています。例えば、最初の<product>は4行目、次の<product>は9行目といった具体的な行番号が出力されます。さらに、product要素の子要素であるnameやpriceについても同様に行番号を取得・表示しており、ドキュメント内の要素の正確な位置を把握するのに役立ちます。この機能は、XML構造のデバッグや、特定の位置情報に基づいた処理の実装に有用です。

Copy
1<?php
2
3/**
4 * DOMElement::getLineNo() の使用例と、PHPの例外処理での行番号取得を組み合わせた関数。
5 * システムエンジニアを目指す初心者向けに、XML要素の行番号と、
6 * 例外発生時のPHPコードの行番号の取得方法を示します。
7 */
8function demonstrateLineNumbers(): void
9{
10    // --- 1. 正常なXMLからDOM要素の行番号を取得する ---
11    echo "--- 1. 正常なXMLからDOM要素の行番号を取得 ---\n";
12
13    // 処理対象となるXML文字列を定義します。
14    $validXml = <<<XML
15<?xml version="1.0" encoding="UTF-8"?>
16<root>
17    <item id="1">
18        <name>Item A</name>
19        <value>100</value>
20    </item>
21    <item id="2">
22        <name>Item B</name>
23        <value>200</value>
24    </item>
25</root>
26XML;
27
28    $dom = new DOMDocument();
29    // DOMDocumentのオプション設定（空白を無視し、整形出力を有効にする）
30    $dom->preserveWhiteSpace = false;
31    $dom->formatOutput = true;
32
33    // XMLをDOMDocumentオブジェクトに読み込みます。
34    $dom->loadXML($validXml);
35
36    // XML内で<name>タグは5行目、<value>タグは6行目にあります（このPHPコードの行数とは異なります）。
37    $nameElement = $dom->getElementsByTagName('name')->item(0);
38    $valueElement = $dom->getElementsByTagName('value')->item(0);
39
40    // 取得したDOMElementオブジェクトが有効かチェックします。
41    if ($nameElement instanceof DOMElement) {
42        // DOMElement::getLineNo() を使用して、元のXML文字列内での要素の行番号を取得します。
43        echo "最初の <name> 要素のXML内行番号: " . $nameElement->getLineNo() . "\n";
44    } else {
45        echo "最初の <name> 要素が見つかりませんでした。\n";
46    }
47
48    if ($valueElement instanceof DOMElement) {
49        // 同様に、<value>要素のXML内行番号を取得します。
50        echo "最初の <value> 要素のXML内行番号: " . $valueElement->getLineNo() . "\n";
51    } else {
52        echo "最初の <value> 要素が見つかりませんでした。\n";
53    }
54    echo "\n";
55
56    // --- 2. 不正なXMLの読み込みで発生したDOMExceptionからPHPコードの行番号を取得する ---
57    echo "--- 2. 不正なXMLの読み込みで発生したDOMExceptionからPHPコードの行番号を取得 ---\n";
58
59    // 不正なXML文字列を定義します。閉じタグが間違っています。
60    $invalidXml = <<<XML
61<root>
62    <item>
63        <name>Item A</name>
64    </invalid_tag> <!-- ここで閉じタグが間違っています -->
65</root>
66XML;
67
68    // libxmlのエラーをPHPの警告として表示しないようにし、
69    // DOMDocument::loadXML()がDOMExceptionをスローするように設定します。
70    libxml_use_internal_errors(true);
71
72    try {
73        $domInvalid = new DOMDocument();
74        // 不正なXMLを読み込もうとすると、DOMException がスローされます。
75        // LIBXML_ERRORS フラグは、パースエラーが発生した場合にDOMExceptionをスローするよう指定します。
76        $domInvalid->loadXML($invalidXml, LIBXML_ERRORS);
77        echo "XMLの読み込みに成功しました (このメッセージは通常表示されません)。\n";
78    } catch (DOMException $e) {
79        // DOMException が発生した場合、ここでキャッチされます。
80        echo "DOMException が発生しました: " . $e->getMessage() . "\n";
81        echo "例外発生PHPコードファイル: " . $e->getFile() . "\n";
82        // Exception::getLine() を使用して、PHPコード内の例外が発生した行番号を取得します。
83        // この場合、`$domInvalid->loadXML(...)` の行が報告されます。
84        echo "例外発生PHPコード行: " . $e->getLine() . "\n";
85
86        // 注意: getLine() はPHPスクリプト内で例外が発生したコード行を示します。
87        // XML内のエラー行は、以下のようにlibxml_get_errors()で確認できます。
88        $errors = libxml_get_errors();
89        foreach ($errors as $error) {
90            echo "  XMLパースエラー: " . trim($error->message) . " (XML内行: " . $error->line . ", カラム: " . $error->column . ")\n";
91        }
92        libxml_clear_errors(); // 取得したエラー情報をクリアします。
93    } finally {
94        // 処理の終了後、libxmlのエラー処理設定を元の状態に戻すことが推奨されます。
95        libxml_use_internal_errors(false);
96    }
97}
98
99// 定義した関数を実行します。
100demonstrateLineNumbers();

PHP 8のDOMElement::getLineNo()メソッドは、XML文書を解析して作成されたDOMElementオブジェクトが、元のXML文字列の何行目に出現したかを示す行番号（整数値）を返します。このメソッドは引数をとりません。

サンプルコードの最初の部分では、DOMElement::getLineNo()を使って、正常なXML内の<name>や<value>といった要素がXML文字列の何行目に位置するかを取得しています。これはXMLファイルの構造を理解したり、特定の要素の場所を把握したりする際に有用です。

次に、不正なXMLを読み込んだ際に発生するDOMExceptionの処理を示しています。ここでは、PHPの例外クラスが共通して持つgetLine()メソッドが登場します。Exception::getLine()は、PHPプログラム内で例外が発生したコードの行番号（このサンプルでは$domInvalid->loadXML(...)の呼び出し箇所）を返します。これはDOMElement::getLineNo()が返すXML要素の行番号とは異なり、PHPスクリプト自体のエラー発生箇所を特定するために使われます。不正なXMLデータ自体のエラー行は、別途libxml_get_errors()関数で詳細を確認できます。

このように、DOMElement::getLineNo()はXMLデータ内の要素の物理的な位置を、Exception::getLine()はPHPコード内の例外発生位置を特定するために使用され、それぞれ異なる目的でシステム開発におけるデバッグや問題解決に役立ちます。