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

Copy
1<?php
2
3/**
4 * DOMNotation::getLineNo() メソッドの利用例を示します。
5 *
6 * この関数は、XMLドキュメント内のDTD (Document Type Definition) で定義された
7 * NOTATION（表記）が、XMLソースのどの行で定義されているかを取得します。
8 *
9 * DOMNotationは、外部の非XMLデータ形式を識別するために使用され、
10 * その定義行番号を取得することでデバッグや検証に役立ちます。
11 */
12function demonstrateDomNotationGetLineNo(): void
13{
14    // DTDにNOTATIONを定義したXML文字列を準備します。
15    // 行番号はXMLの先頭から数えられます。
16    $xmlString = <<<XML
17<?xml version="1.0"?>
18<!DOCTYPE document [
19  <!-- このXMLドキュメントのNOTATION定義 -->
20  <!NOTATION gif SYSTEM "image/gif">
21  <!NOTATION jpeg PUBLIC "JPG File" "image/jpeg">
22  <!NOTATION pdf SYSTEM "application/pdf">
23]>
24<document/>
25XML;
26
27    // DOMDocumentオブジェクトを作成します。
28    // これはXMLドキュメント全体を表現するクラスです。
29    $dom = new DOMDocument();
30
31    // XMLのパース中に発生するエラーを抑制し、内部で処理するように設定します。
32    // これにより、エラーメッセージがPHPの警告として直接出力されるのを防ぎます。
33    libxml_use_internal_errors(true);
34
35    // XML文字列をDOMDocumentにロードします。
36    // 成功した場合はtrue、失敗した場合はfalseを返します。
37    if (!$dom->loadXML($xmlString)) {
38        echo "XMLのロードに失敗しました。\n";
39        // エラー情報を取得して表示します。
40        foreach (libxml_get_errors() as $error) {
41            echo "  エラー: " . trim($error->message) . " (行: {$error->line})\n";
42        }
43        libxml_clear_errors(); // 取得したエラーをクリアします。
44        return;
45    }
46    // エラー表示設定を元に戻します。
47    libxml_use_internal_errors(false);
48
49    // ドキュメントのDTD (Document Type Definition) オブジェクトを取得します。
50    // DTDはXMLドキュメントの構造や要素の定義を記述する部分です。
51    $doctype = $dom->doctype;
52
53    // DTDが存在しない場合は、処理を中断します。
54    if (!$doctype) {
55        echo "XMLドキュメントにDTD (Document Type Definition) が見つかりませんでした。\n";
56        return;
57    }
58
59    // DTD内のNOTATIONリストを取得します。
60    // notationsプロパティは、DOMNamedNodeMapオブジェクトを返し、
61    // その中にDOMNotationオブジェクトが格納されています。
62    $notations = $doctype->notations;
63
64    // NOTATIONが一つも定義されていない場合は、処理を中断します。
65    if ($notations->length === 0) {
66        echo "DTD内にNOTATIONが定義されていません。\n";
67        return;
68    }
69
70    echo "DTDに定義されているNOTATIONとそのXMLソース上の行番号:\n";
71
72    // 取得したNOTATIONリストをループし、各NOTATIONの情報を表示します。
73    foreach ($notations as $notation) {
74        // オブジェクトがDOMNotationのインスタンスであることを確認します。
75        if ($notation instanceof DOMNotation) {
76            // NOTATIONの名前を取得します。
77            $name = $notation->nodeName;
78            // DOMNotation::getLineNo() メソッドを使用して、
79            // NOTATIONがXMLソースのどの行で定義されているかを取得します。
80            $lineNumber = $notation->getLineNo();
81
82            echo "- NOTATION '{$name}' はXMLソースの行番号 {$lineNumber} で定義されています。\n";
83        }
84    }
85}
86
87// 定義した関数を実行し、サンプルコードの動作を確認します。
88demonstrateDomNotationGetLineNo();
89
90?>

PHPのDOMNotation::getLineNo()メソッドは、XMLドキュメントのDTD（Document Type Definition）で定義されるNOTATION（表記）が、XMLソースのどの行で定義されているかを取得するものです。DOMNotationクラスは、XML外部の非XMLデータ形式を識別するために使われるNOTATION要素を表します。このメソッドは引数を取らず、XMLドキュメントの先頭を1行目として数え、該当のNOTATION定義が記載されている行番号を整数値で返します。

サンプルコードでは、NOTATIONを定義したXML文字列をDOMDocumentにロードし、DTDからNOTATIONオブジェクトのリストを取得しています。そして、各DOMNotationオブジェクトに対してgetLineNo()メソッドを呼び出し、そのNOTATIONがXMLソースの何行目で定義されているかを具体的に表示しています。この機能は、XMLのデバッグや検証に役立ちます。

Copy
1<?php
2
3/**
4 * 除算処理を行い、0 での除算が発生した場合は例外をスローします。
5 *
6 * @param float $numerator 除算される数（分子）
7 * @param float $denominator 除数（分母）
8 * @return float 除算結果
9 * @throws InvalidArgumentException 0 で除算しようとした場合
10 */
11function safeDivide(float $numerator, float $denominator): float
12{
13    // 分母が 0 かどうかをチェック
14    if ($denominator === 0.0) {
15        // 0 で除算しようとした場合は例外をスロー
16        // この行番号が Exception::getLine() で取得されます。
17        throw new InvalidArgumentException("Cannot divide by zero."); // この行の番号に注目
18    }
19    return $numerator / $denominator;
20}
21
22// 例外処理ブロック
23try {
24    echo "通常の除算の試行:\n";
25    $result = safeDivide(10, 2);
26    echo "結果: " . $result . "\n\n";
27
28    echo "0 での除算の試行（例外が発生する）:\n";
29    // ここで例外が発生します
30    $result = safeDivide(10, 0); // この関数呼び出しの内部で例外がスローされる
31    echo "この行は実行されません。\n"; // 例外が捕捉されるため、この行はスキップされる
32
33} catch (InvalidArgumentException $e) {
34    // 発生した例外を捕捉
35    echo "例外を捕捉しました！\n";
36    echo "メッセージ: " . $e->getMessage() . "\n"; // 例外のメッセージを取得
37    echo "例外が発生したファイル: " . $e->getFile() . "\n"; // 例外が発生したファイル名を取得
38    echo "例外が発生した行: " . $e->getLine() . "\n"; // 例外が発生したPHPコードの行番号を取得
39} catch (Exception $e) {
40    // その他の一般的な例外を捕捉
41    echo "不明な例外を捕捉しました: " . $e->getMessage() . "\n";
42}
43

PHPのException::getLine()メソッドは、プログラム実行中に発生した例外が、PHPコードのどの行でスローされたかを取得します。このメソッドは引数を受け取らず、例外がスローされた行番号を整数（int）で返します。

サンプルコードは、0による除算を安全に行うsafeDivide関数と、その例外処理を示しています。safeDivide関数は、分母が0の場合にInvalidArgumentExceptionをスローするよう設計されています。

try-catchブロック内でsafeDivide(10, 0)のように0で除算を試みると、safeDivide関数内部のthrow new InvalidArgumentException("Cannot divide by zero.");と記述された行で例外が発生します。この例外がcatchブロックで捕捉された後、$e->getLine()メソッドを呼び出すと、実際にこのthrow文が書かれたPHPコードの行番号を整数値で取得できます。

getLine()で得られる情報は、$e->getMessage()で取得するメッセージや$e->getFile()で取得するファイル名と組み合わせることで、エラーの原因や発生箇所を正確に特定し、効率的なデバッグを可能にします。システムエンジニアにとって、例外ハンドリングを行う上で非常に重要な情報源となります。