【PHP8.x】versionプロパティの使い方

Copy
1<?php
2
3/**
4 * DOMDocument::version プロパティの利用例
5 *
6 * このコードは、PHPのDOMDocumentクラスを使用してXMLドキュメントを読み込み、
7 * そのXML宣言で指定されているバージョン番号を取得する方法を示します。
8 * XMLドキュメントのバージョンは通常「1.0」であり、これが現在最も広く採用されているXMLのバージョンです。
9 * （これはPHPのバージョンとは異なりますのでご注意ください。）
10 */
11
12// サンプルXMLドキュメント文字列。バージョン "1.0" を指定しています。
13$xmlString = '<?xml version="1.0" encoding="UTF-8"?><data><item>サンプルデータ</item></data>';
14
15// DOMDocumentオブジェクトをインスタンス化
16$dom = new DOMDocument();
17
18// XML読み込み時の警告（不正なXML形式の場合など）を抑制するため、
19// libxmlのエラー処理を一時的に内部化します。
20libxml_use_internal_errors(true);
21
22// XML文字列をDOMDocumentに読み込みます
23$loaded = $dom->loadXML($xmlString);
24
25// 内部化したエラー情報をクリアし、他の処理に影響が出ないようにします。
26libxml_clear_errors();
27
28if ($loaded) {
29    // DOMDocument::version プロパティにアクセスして、XMLドキュメントのバージョンを取得します。
30    // このプロパティは、XML宣言 (<?xml version="..." ?>) から読み取られた値を提供します。
31    $xmlVersion = $dom->version;
32
33    echo "読み込んだXMLドキュメントのバージョン: " . $xmlVersion . PHP_EOL;
34
35} else {
36    echo "エラー: XMLの読み込みに失敗しました。提供されたXMLが不正な形式の可能性があります。" . PHP_EOL;
37}
38
39?>

PHPのDOMDocument::versionプロパティは、XMLドキュメントのバージョン情報を取得するために使用されます。DOMDocumentクラスは、XMLドキュメントをオブジェクトとして扱い、その構造や内容を操作するための機能を提供します。このversionプロパティは、XMLドキュメントが持つXML宣言（例: <?xml version="1.0" encoding="UTF-8"?>）の中で指定されているversion属性の値を取得します。引数はなく、戻り値は文字列型です。

サンプルコードでは、まずXML文字列が用意されています。次に、DOMDocumentオブジェクトが作成され、loadXML()メソッドを使ってこのXML文字列がオブジェクトに読み込まれます。読み込みが成功すると、$dom->versionという形でプロパティにアクセスすることで、XMLドキュメントのバージョン情報が文字列として得られます。このプロパティが返すバージョンは、通常「1.0」であり、これは現在最も広く採用されているXMLの標準的なバージョンを示します。

重要な点として、このversionプロパティが示すのは「XMLドキュメントのバージョン」であり、「PHP言語自体のバージョン」とは異なりますのでご注意ください。このプロパティを利用することで、プログラムから読み込んだXMLデータの仕様バージョンを簡潔に確認し、その後の処理の判断材料として活用することができます。

Copy
1<?php
2
3/**
4 * XMLドキュメントのバージョンを取得するサンプルコードです。
5 *
6 * この関数は、PHPのDOMDocumentクラスを使用して、XMLドキュメントに記述されているXMLバージョン（例: <?xml version="1.0"?> の "1.0"）
7 * を確認する方法を示します。
8 *
9 * 注意: DOMDocument::version プロパティは、PHP言語自体のバージョンではなく、
10 * 読み込んだXMLドキュメントのバージョン情報です。
11 * PHP言語のバージョンを確認するには、phpversion() 関数や PHP_VERSION 定数を使用します。
12 *
13 * @param string $xmlContent 処理するXML文字列
14 * @return string|null XMLドキュメントのバージョン文字列を返します。
15 *                     XML宣言にバージョンが明示されていない場合は空文字列を返します。
16 *                     XMLのロードに失敗した場合は null を返します。
17 */
18function getXmlDocumentVersion(string $xmlContent): ?string
19{
20    $dom = new DOMDocument();
21    
22    // libxmlのエラーを内部で捕捉し、PHPの警告として出力されないように設定します。
23    // これにより、XMLパースエラーが発生してもスクリプトの実行が中断されにくくなります。
24    libxml_use_internal_errors(true); 
25
26    // XML文字列をDOMオブジェクトにロードします。
27    // 成功した場合は true、失敗した場合は false を返します。
28    if (!$dom->loadXML($xmlContent)) {
29        // XMLのロードに失敗した場合、捕捉したエラー情報を処理します。
30        $errors = libxml_get_errors();
31        foreach ($errors as $error) {
32            // システムエンジニアを目指す初心者向けに、エラー内容を簡潔に表示します。
33            // 実際の本番環境では、ログファイルへの記録など、より詳細なエラーハンドリングが推奨されます。
34            echo "XML Load Error: [Level " . $error->level . "] " . $error->message . " at line " . $error->line . "\n";
35        }
36        libxml_clear_errors(); // 内部エラーバッファをクリアします。
37        libxml_use_internal_errors(false); // エラーハンドリング設定を元に戻します。
38        return null; // ロード失敗時は null を返して処理を終了します。
39    }
40    
41    // ロードが成功した場合も、念のためエラーバッファをクリアし、設定を元に戻します。
42    libxml_clear_errors(); 
43    libxml_use_internal_errors(false);
44
45    // DOMDocument::version プロパティは、XML宣言で指定されたバージョンを返します。
46    // 例: `<?xml version="1.0" encoding="UTF-8"?>` の場合、"1.0" を返します。
47    // XML宣言にバージョン情報が明示されていない場合は、空の文字列を返します。
48    return $dom->version;
49}
50
51// --- 以下、サンプル実行例 ---
52
53// 1. バージョン情報を含むXMLの例
54$xmlWithVersion = '<?xml version="1.0" encoding="UTF-8"?>
55<data><message>Hello XML</message></data>';
56
57$version1 = getXmlDocumentVersion($xmlWithVersion);
58if ($version1 !== null) {
59    echo "XML Document 1 Version: " . ($version1 === '' ? '[Not specified]' : $version1) . "\n";
60} else {
61    echo "Failed to get version for XML Document 1.\n";
62}
63
64// 2. バージョン情報を含まないXMLの例
65$xmlWithoutVersion = '<data><message>No explicit version</message></data>';
66
67$version2 = getXmlDocumentVersion($xmlWithoutVersion);
68if ($version2 !== null) {
69    echo "XML Document 2 Version: " . ($version2 === '' ? '[Not specified]' : $version2) . "\n";
70} else {
71    echo "Failed to get version for XML Document 2.\n";
72}
73
74// 3. 無効なXMLの例
75$invalidXml = '<data><message>Malformed XML</data>'; // 閉じタグが不足しています
76
77$version3 = getXmlDocumentVersion($invalidXml);
78if ($version3 !== null) {
79    echo "XML Document 3 Version: " . ($version3 === '' ? '[Not specified]' : $version3) . "\n";
80} else {
81    echo "Failed to get version for XML Document 3 due to invalid XML.\n";
82}

PHPのDOMDocumentクラスにあるversionプロパティは、読み込んだXMLドキュメントのバージョン情報を取得するために使用されます。これはPHP言語のバージョンではなく、XMLファイル内に記述されているXML宣言（例えば<?xml version="1.0" encoding="UTF-8"?>における"1.0"の部分）を指します。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、引数で渡されたXML文字列をloadXML()メソッドで読み込みます。XMLの読み込みに成功した場合、$dom->versionプロパティを参照することで、そのXMLドキュメントのバージョン文字列を取得できます。XML宣言にバージョン情報が明示されていない場合は、空の文字列が返されます。

また、libxml_use_internal_errors()関数を使ってXMLパース時のエラーを内部で捕捉し、XMLの形式が不正でロードに失敗した場合には、そのエラー情報を表示してnullを返す堅牢なエラーハンドリングの例も示しています。このversionプロパティ自体は、特に引数を必要としません。XMLデータをプログラムで扱う際に、ドキュメントの基本的なバージョン情報を確認するために役立つ機能です。