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

Copy
1<?php
2
3/**
4 * 指定されたXML文字列を正規化し、ファイルに書き出します。
5 * DOMAttr::C14NFile メソッドはPHPの標準ライブラリには存在しないため、
6 * 一般的に使用される DOMDocument::C14NFile メソッドの振る舞いを示します。
7 * C14NFile の引数シグネチャは、リファレンス情報に提示された DOMAttr のものと同一です。
8 *
9 * @param string $xmlString 正規化するXMLデータを含む文字列。
10 * @param string $outputPath 正規化されたXMLを書き出すファイルのパス。
11 * @param bool $exclusive 排他的な正規化を適用するかどうか。デフォルトはfalse。
12 * @param bool $withComments コメントを正規化された出力に含めるかどうか。デフォルトはfalse。
13 * @param array|null $xpath XPath表現の配列。指定されたノードのみを正規化の対象とします。デフォルトはnull。
14 * @param array|null $nsPrefixes 名前空間プレフィックスの配列。デフォルトはnull。
15 * @return bool ファイル書き出しが成功した場合はtrue、それ以外はfalse。
16 */
17function createCanonicalXmlFile(
18    string $xmlString,
19    string $outputPath,
20    bool $exclusive = false,
21    bool $withComments = false,
22    ?array $xpath = null,
23    ?array $nsPrefixes = null
24): bool {
25    // DOMDocument オブジェクトを新しく作成します。
26    $dom = new DOMDocument('1.0', 'UTF-8');
27    // 空白ノードを保持しないように設定します。
28    // C14Nでは通常、不必要な空白は除去されるため、この設定が望ましいです。
29    $dom->preserveWhiteSpace = false;
30    // 出力時に整形を有効にします（デバッグや可読性向上に役立ちますが、C14Nの出力自体には影響しません）。
31    $dom->formatOutput = true;
32
33    // XML文字列をDOMDocumentに読み込みます。
34    // 無効なXMLが与えられた場合を考慮します。
35    if (!$dom->loadXML($xmlString)) {
36        error_log("Error: Failed to load XML string.");
37        return false;
38    }
39
40    // DOMDocument の C14NFile メソッドを使用して、XMLを正規化しファイルに書き出します。
41    // このメソッドのシグネチャは、ユーザーが提示した DOMAttr::C14NFile と一致します。
42    $result = $dom->C14NFile(
43        $outputPath,
44        $exclusive,
45        $withComments,
46        $xpath,
47        $nsPrefixes
48    );
49
50    if (!$result) {
51        error_log("Error: Failed to write canonical XML to '{$outputPath}'.");
52    }
53
54    return $result;
55}
56
57// --- サンプル使用例 ---
58
59// 正規化するXMLデータ
60$sampleXml = <<<XML
61<root xmlns="http://example.com/ns" xmlns:prefix="http://example.com/prefix">
62    <element attr="value">
63        <prefix:child>データ</prefix:child>
64        <!-- これはコメントです -->
65        <anotherChild> more data </anotherChild>
66    </element>
67</root>
68XML;
69
70// 正規化されたXMLを出力するファイルパス
71$outputFile = __DIR__ . '/canonical_output.xml';
72
73// 正規化関数を呼び出し、結果を表示します。
74echo "Canonical XMLファイルの生成を試行します。\n";
75$success = createCanonicalXmlFile($sampleXml, $outputFile, false, true); // コメントを含めて正規化
76
77if ($success) {
78    echo "Canonical XMLが '{$outputFile}' に正常に書き出されました。\n";
79    // 生成されたファイルの内容を表示 (オプション)
80    echo "\n--- 生成されたファイルの内容 ---\n";
81    echo htmlspecialchars(file_get_contents($outputFile)) . "\n";
82    echo "------------------------------\n";
83
84    // サンプル実行後にファイルを削除 (クリーンアップ)
85    if (file_exists($outputFile)) {
86        unlink($outputFile);
87        echo "一時ファイル '{$outputFile}' を削除しました。\n";
88    }
89} else {
90    echo "Canonical XMLファイルの書き出しに失敗しました。\n";
91}

PHPのこのサンプルコードは、XMLデータを「正規化（Canonicalization: C14N）」し、その結果を指定されたファイルに書き出す方法を示しています。XMLの正規化とは、XMLの記述方法の違いを吸収し、論理的に同じ内容であれば必ず同じバイト列になるように変換することで、XMLの同一性検証などに利用されます。

リファレンス情報ではDOMAttr::C14NFileメソッドが提示されていますが、PHPの標準ライブラリにはこのメソッドは存在しません。そのため、サンプルコードではXMLドキュメント全体を正規化する際に一般的に使用されるDOMDocument::C14NFileメソッドの振る舞いを、リファレンスで示された引数シグネチャと同一の関数として実装し、その利用方法を紹介しています。

この関数は、正規化するXMLデータを含む$xmlStringと、正規化されたXMLを書き出すファイルのパスである$outputPathを必須引数として受け取ります。オプション引数として、$exclusiveで排他的な正規化を適用するか、$withCommentsでコメントを正規化された出力に含めるかを指定できます。また、$xpath引数で正規化の対象を特定のノードに絞り込んだり、$nsPrefixes引数で名前空間プレフィックスを制御したりすることも可能です。

メソッドの戻り値はブール型で、ファイルの書き出しが成功した場合はtrue、失敗した場合はfalseを返します。サンプルコードでは、まずDOMDocumentオブジェクトにXML文字列を読み込み、その後C14NFileメソッドを呼び出して、正規化されたXMLをファイルに保存する一連の流れを確認できます。

Copy
1<?php
2
3/**
4 * 指定されたXML文字列から特定の属性を抽出し、その属性ノードをW3C Canonical XML 1.0 (C14N) 形式でファイルに保存します。
5 *
6 * DOMAttr::C14NFile は DOMNode::C14NFile を継承しており、属性ノードの正規化に利用できます。
7 * しかし、属性ノード単体の正規化結果は、XMLのC14N仕様上、期待する出力とならない場合や空のファイルとなる場合があります。
8 * 通常、C14NはDOMDocumentやDOMElementなどの要素ツリーに対して適用されます。
9 *
10 * @param string $xmlString XMLドキュメントの文字列。
11 * @param string $attributeName 正規化対象の属性名。
12 * @param string $outputFilePath 正規化された内容を保存するファイルパス。
13 * @return bool 処理が成功した場合に true、XMLのパース失敗、属性が見つからない、またはファイル書き込み失敗の場合に false を返します。
14 */
15function canonicalizeAttributeToFile(string $xmlString, string $attributeName, string $outputFilePath): bool
16{
17    // DOMDocumentオブジェクトを生成
18    $dom = new DOMDocument();
19
20    // XMLのパースエラーを抑制し、内部エラーハンドリングを使用
21    libxml_use_internal_errors(true);
22    // XML文字列をDOMDocumentにロード
23    $loaded = $dom->loadXML($xmlString);
24    libxml_clear_errors(); // エラーバッファをクリア
25    libxml_use_internal_errors(false); // 元の設定に戻す
26
27    if (!$loaded) {
28        return false; // XMLのロードに失敗
29    }
30
31    // ドキュメント内のすべての要素から指定された属性を探す
32    $elements = $dom->getElementsByTagName('*');
33    $targetAttr = null;
34
35    foreach ($elements as $element) {
36        /** @var DOMElement $element */
37        if ($element->hasAttribute($attributeName)) {
38            $targetAttr = $element->getAttributeNode($attributeName);
39            break; // 最初の見つかった属性ノードを使用
40        }
41    }
42
43    if ($targetAttr === null) {
44        return false; // 指定された属性が見つからなかった
45    }
46
47    // DOMAttrインスタンスのC14NFileメソッドを呼び出し、正規化された内容をファイルに書き込む
48    // 引数:
49    // $uri (string): 正規化されたXMLを保存するファイルパス。
50    // $exclusive (bool): 排他的正規化モードを使用するかどうか。falseで通常のC14N。
51    // $with_comments (bool): コメントを正規化された出力に含めるかどうか。falseで含めない。
52    // $xpath (?array): 正規化の対象をXPath式でフィルタリングする場合に指定。今回はnull。
53    // $ns_prefixes (?array): 名前空間プレフィックスによるフィルタリングの場合に指定。今回はnull。
54    $success = $targetAttr->C14NFile($outputFilePath, false, false, null, null);
55
56    return $success;
57}
58
59// -----------------------------------------------------------------------------
60// サンプルコード実行例
61// (出力条件「サンプルコード以外の出力は行わない」を遵守するため、ここでは何も表示しません。)
62// -----------------------------------------------------------------------------
63
64// サンプルXML文字列
65$sampleXml = <<<XML
66<?xml version="1.0" encoding="UTF-8"?>
67<root xmlns:ns="http://example.com/ns">
68    <item id="item-001" ns:data="value" attribute_with_value="sample value">
69        <!-- This is a comment -->
70        Hello, World!
71    </item>
72    <item id="item-002">
73        Another Item.
74    </item>
75</root>
76XML;
77
78// 正規化対象の属性名
79$attributeToExtract = 'id'; // 例として 'id' 属性をターゲットとする
80
81// 出力ファイルパス
82$outputFilePath = 'canonicalized_attribute.xml';
83
84// 関数を実行
85$result = canonicalizeAttributeToFile($sampleXml, $attributeToExtract, $outputFilePath);
86
87// $result が true の場合、ファイル 'canonicalized_attribute.xml' が生成されます。
88// そのファイルの内容は、'item-001' の 'id' 属性が正規化された形式です。
89// (ただし、属性ノード単体の正規化は、空のファイルや期待と異なる出力となる場合があります。)
90// この結果は通常、テストコードやログで確認されます。
91// 例: if ($result) { echo "Success!"; } else { echo "Failure!"; } のような出力は、
92// この出力条件では禁止されています。

このPHPサンプルコードは、XML文字列から特定の属性ノードを抽出し、その属性ノードをW3C Canonical XML 1.0 (C14N) 形式でファイルに保存する方法を実演しています。PHPのDOMAttrクラスが提供するC14NFileメソッドを利用しており、これはDOMノードを正規化して指定のファイルに書き出すためのものです。

コード内のcanonicalizeAttributeToFile関数は、XML文字列と正規化対象の属性名、出力ファイルパスを受け取ります。XMLをDOMDocumentにロード後、指定された属性名を持つノードを探索します。属性ノードが見つかると、そのDOMAttrインスタンスに対してC14NFileメソッドが呼び出されます。

C14NFileメソッドは、第一引数に正規化結果を保存するファイルパス（$uri）を指定します。続く引数で排他的正規化の有無（$exclusive）やコメントを含めるかどうか（$with_comments）を設定できますが、このサンプルでは基本的な設定を使用しています。オプションのXPathや名前空間プレフィックスによるフィルタリング引数はここではnullです。メソッドは処理の成功可否を真偽値（bool）で返します。

重要な点として、DOMAttr::C14NFileはDOMNodeを継承していますが、XMLのC14N仕様上、属性ノード単体の正規化結果は空のファイルとなるか、期待する出力と異なる場合があります。C14Nは通常、DOMDocumentやDOMElementのような要素ツリー全体に対して適用されることが一般的です。このサンプルを実行すると、canonicalized_attribute.xmlというファイルが生成されますが、その内容は前述の理由により限定的なものとなります。