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

getLineNoメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年11月24日

基本的な使い方

getLineNoメソッドは、DOMTextオブジェクトが表すテキストノードが、元のドキュメント内の何行目に位置するかを数値で取得するメソッドです。PHPのDOM拡張モジュールの一部として提供されており、XMLやHTMLなどのドキュメント構造をプログラムで操作する際に利用します。

DOMTextクラスは、ドキュメント内のテキスト部分、例えば要素の間の文字列や属性値などをカプセル化したものです。このgetLineNoメソッドは、特定のテキストノードがドキュメントのソースコード上で実際に何行目に書かれているかを知りたい場合に非常に役立ちます。

例えば、ドキュメントを解析している際に特定のテキストコンテンツに問題があることを発見した場合、このメソッドを使用することで、その問題のあるテキストがドキュメントの何行目にあるのかを正確に特定できます。これは、構文エラーのデバッグや、ユーザーにエラー箇所を報告する際の情報提供として非常に有用です。戻り値は整数で、行番号は通常1から始まります。このメソッドは、特に大規模なドキュメントや複雑な構造を持つドキュメントを扱うシステムにおいて、堅牢なエラーハンドリングやデバッグ機能の実装に貢献します。

構文(syntax)


1<?php
2
3$doc = new DOMDocument();
4$doc->loadXML('<root><element>テキストノード</element></root>');
5
6$element = $doc->getElementsByTagName('element')->item(0);
7$domTextNode = $element->firstChild;
8
9$lineNumber = $domTextNode->getLineNo();
10
11?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

このメソッドは、ノードが属する文書内での行番号を整数で返します。

サンプルコード

PHP DOMText::getLineNo() で行番号を取得する


1<?php
2
3/**
4 * DOMText::getLineNo() メソッドの使用例を示します。
5 * このメソッドは、DOMツリー内のテキストノードが元のドキュメントの何行目に位置するかを取得します。
6 */
7function demonstrateDomTextGetLineNo(): void
8{
9    // DOMDocument オブジェクトを作成します。
10    $dom = new DOMDocument();
11
12    // 解析するHTML文字列を定義します。
13    // 行番号が分かりやすいように、複数行で記述しています。
14    // <!DOCTYPE html> が1行目として数えられます。
15    $htmlContent = <<<HTML
16<!DOCTYPE html>
17<html>
18<head>
19    <title>DOM Line Number Example</title>
20</head>
21<body>
22    <p>
23        Hello, 
24        this is a 
25        sample text.
26    </p>
27    <div>
28        Another piece of text.
29    </div>
30</body>
31</html>
32HTML;
33
34    // HTML解析時の警告を抑制し、HTML文字列をDOMDocumentにロードします。
35    libxml_use_internal_errors(true);
36    $dom->loadHTML($htmlContent);
37    libxml_use_internal_errors(false); // 警告抑制を元に戻します
38
39    // 最初の<p>タグ内のテキストノードを探し、その行番号を取得します。
40    $paragraphs = $dom->getElementsByTagName('p');
41    if ($paragraphs->length > 0) {
42        $pElement = $paragraphs->item(0); // 最初の <p> 要素を取得
43
44        // <p>要素の子ノードをループし、DOMTextインスタンス（テキストノード）を探します。
45        // DOMは空白や改行もテキストノードとして扱うため、内容が空でないものを対象とします。
46        foreach ($pElement->childNodes as $node) {
47            if ($node instanceof DOMText && trim($node->nodeValue) !== '') {
48                echo "最初の<p>タグ内のテキストノード:\n";
49                echo "  内容: \"" . trim($node->nodeValue) . "\"\n";
50                echo "  元のHTMLでの行番号: " . $node->getLineNo() . "\n";
51                break; // 最初の有効なテキストノードを見つけたら終了
52            }
53        }
54    }
55
56    echo "\n"; // 出力間の区切り
57
58    // 最初の<div>タグ内のテキストノードを探し、その行番号を取得します。
59    $divs = $dom->getElementsByTagName('div');
60    if ($divs->length > 0) {
61        $divElement = $divs->item(0); // 最初の <div> 要素を取得
62
63        // <div>要素の子ノードをループし、DOMTextインスタンスを探します。
64        foreach ($divElement->childNodes as $node) {
65            if ($node instanceof DOMText && trim($node->nodeValue) !== '') {
66                echo "最初の<div>タグ内のテキストノード:\n";
67                echo "  内容: \"" . trim($node->nodeValue) . "\"\n";
68                echo "  元のHTMLでの行番号: " . $node->getLineNo() . "\n";
69                break; // 最初の有効なテキストノードを見つけたら終了
70            }
71        }
72    }
73}
74
75// 関数を実行してサンプルコードの動作を確認します。
76demonstrateDomTextGetLineNo();

PHP 8で提供されるDOMText::getLineNo()メソッドは、DOM（Document Object Model）ツリー内のテキストノードが、元のHTMLドキュメントの何行目に位置するかを整数で取得する機能です。このメソッドは引数を一切必要とせず、対象のテキストノードが元のドキュメントで始まった行番号をint型で返します。

サンプルコードでは、DOMDocumentオブジェクトを作成し、複数行にわたるHTML文字列をロードしてDOMツリーを構築しています。<!DOCTYPE html>が1行目としてカウントされるため、後続の行番号はそれに基づいて計算されます。コードはまず、最初の<p>タグと<div>タグを見つけます。その後、それぞれの要素の子ノードをループ処理し、DOMTextのインスタンス（テキストノード）であるか、また空白以外の有効な内容を持つかをチェックします。有効なテキストノードが見つかると、$node->getLineNo()を呼び出し、そのテキストが元のHTMLコンテンツで何行目に位置していたかを表示しています。この機能は、HTMLコンテンツの特定部分がソースドキュメントのどこに記述されているかを把握したい場合や、ドキュメント構造のデバッグなどに活用できます。

このサンプルコードでは、DOMがHTML内の改行や空白もテキストノードとして扱うため、目的のテキストノードを見つけるにはtrim($node->nodeValue) !== ''のような空ノードの除外処理が重要です。getLineNo()メソッドは、元のHTMLドキュメント上の行番号を返しますが、プログラムで新規作成したDOMTextオブジェクトでは常に0を返しますので注意が必要です。また、libxml_use_internal_errorsでHTML解析時の警告を抑制していますが、実際のシステムでは警告の内容を確認できるようエラーログの監視や適切なエラーハンドリングを検討することが推奨されます。行番号はドキュメントの先頭から数えられます。

DOMText::getLineNo で行番号を取得する


1<?php
2
3/**
4 * DOMText::getLineNo メソッドの使用例をデモンストレーションします。
5 * システムエンジニアを目指す初心者向けに、簡潔で分かりやすいコードです。
6 */
7function demonstrateDomTextGetLineNo(): void
8{
9    // キーワード 'exception' に対応するため、DOM操作全体をtry-catchで囲みます。
10    // PHPのDOM拡張は、多くのメソッドがエラー時にWarningを発生させますが、
11    // 稀にDOMExceptionをスローすることもあります。
12    try {
13        $dom = new DOMDocument();
14        // HTMLをロードする際のエラー表示を抑制します。
15        // preserveWhiteSpaceとformatOutputは、より整形されたDOM構造を得るために設定されます。
16        $dom->preserveWhiteSpace = false;
17        $dom->formatOutput = true;
18
19        $htmlContent = <<<HTML
20<!DOCTYPE html>
21<html>
22<body>
23    <h1>DOMText::getLineNo のテスト</h1>
24    <p>
25        これは、最初のテキストノードです。
26        <span>強調された部分です。</span>
27        さらに別のテキストです。
28    </p>
29    <div>
30        これは別の要素内のテキストです。
31    </div>
32</body>
33</html>
34HTML;
35
36        // HTML文字列をDOMDocumentにロードします。
37        // @ 演算子を使用して、loadHTMLが生成する可能性のある警告を抑制します。
38        if (!@$dom->loadHTML($htmlContent)) {
39            echo "エラー: HTMLのロードに失敗しました。\n";
40            return;
41        }
42
43        echo "DOMText::getLineNo() のサンプル:\n";
44
45        // <p> タグを探し、その中のテキストノードから行番号を取得します。
46        $paragraphs = $dom->getElementsByTagName('p');
47
48        if ($paragraphs->length > 0) {
49            $pElement = $paragraphs->item(0); // 最初の <p> 要素を取得します。
50
51            // <p> 要素の子ノードを調べて DOMText ノードを見つけます。
52            foreach ($pElement->childNodes as $node) {
53                // DOMText型のノードであり、かつ空白文字のみでない場合に処理します。
54                if ($node instanceof DOMText && trim($node->nodeValue) !== '') {
55                    // DOMText::getLineNo は、元のファイルにおけるテキストノードの開始行番号を返します。
56                    // 注意: DOMDocument::loadHTML() や DOMDocument::loadXML() で「文字列から」ロードした場合、
57                    // getLineNo() は通常 '0' を返します。
58                    // これは、DOMが文字列を「メモリ上」で生成するため、ファイル上の具体的な行情報を持たないためです。
59                    // 実際のファイルから loadHTMLFile() や loadXMLFile() で読み込んだ場合にのみ、
60                    // 正確な行番号が期待できます。
61                    $lineNumber = $node->getLineNo();
62                    $displayValue = mb_substr(trim($node->nodeValue), 0, 50); // 長いテキストを短く表示
63                    echo "  テキストノード: '{$displayValue}...' (行番号: {$lineNumber})\n";
64                    // 最初の意味のあるテキストノードを見つけたらループを終了します。
65                    break;
66                }
67            }
68        } else {
69            echo "  <p>要素が見つかりませんでした。\n";
70        }
71
72    } catch (DOMException $e) {
73        // DOM関連の操作で発生する可能性のある例外（DOMException）をキャッチします。
74        echo "エラー: DOM操作中に例外が発生しました: " . $e->getMessage() . "\n";
75    } catch (Exception $e) {
76        // その他の予期せぬ一般的な例外をキャッチします。
77        echo "エラー: 予期せぬ例外が発生しました: " . $e->getMessage() . "\n";
78    }
79}
80
81// サンプル関数を実行します。
82demonstrateDomTextGetLineNo();
83
84?>

PHPのDOMText::getLineNoメソッドは、DOMツリー内のテキストノードが元のドキュメントの何行目から始まるかを示す行番号を取得するために使用されます。このメソッドは引数を一切取らず、戻り値として整数型（int）の行番号を返します。

サンプルコードでは、まずHTML文字列をDOMDocumentオブジェクトに読み込み、その後、そのドキュメント内の<p>タグにあるテキストノードを探索しています。見つかったテキストノードに対してgetLineNoメソッドを呼び出し、そのノードがHTML文字列内の何行目にあるかを行番号として取得し、表示します。

重要な点として、DOMDocument::loadHTML()やDOMDocument::loadXML()のように、文字列からドキュメントをロードした場合、getLineNoメソッドは通常「0」を返します。これは、メモリ上で構築されたDOM構造が元のファイル上の具体的な行情報を持たないためです。実際のファイルから行番号を取得したい場合は、DOMDocument::loadHTMLFile()やDOMDocument::loadXMLFile()メソッドを使用する必要があります。

また、DOM操作中に予期せぬエラーが発生する可能性に備え、サンプルコードではtry-catchブロックを使って処理全体を囲んでいます。これにより、DOMExceptionなどの例外が発生しても、プログラムが突然終了することなく、エラーメッセージを適切に表示し対処することができます。

DOMText::getLineNo() メソッドは、PHPがHTMLやXMLを「文字列」からロードした場合、元のファイル情報を持たないため、通常「0」を返します。正確な行番号を取得するには、DOMDocument::loadHTMLFile() などのメソッドで「ファイル」からロードする必要があります。DOM操作では、多くの場合Warningが発生するため、@演算子で警告を抑制する際は、エラーを見逃さないよう注意が必要です。より堅牢なエラー処理には、libxml_use_internal_errors(true) を利用し、エラーメッセージを明示的に取得する方法も検討してください。また、DOM操作中にまれにDOMExceptionがスローされる可能性があるため、try-catchブロックによる例外処理を行うとより安全です。テキストノードを処理する際には、trim()関数で空白のみのノードを除外することで、意味のあるテキスト内容にアクセスしやすくなります。