【PHP8.x】XML_OPTION_CASE_FOLDING定数の使い方

Copy
1<?php
2
3/**
4 * XML_OPTION_CASE_FOLDING 定数の動作を示すサンプルコードです。
5 *
6 * この定数はXMLパーサーが要素名（タグ名）を処理する際、大文字小文字を区別するかどうかを設定します。
7 * デフォルトでは true (大文字小文字を区別せず、すべてのタグ名は大文字に変換される) です。
8 * このサンプルでは、XML_OPTION_CASE_FOLDING を false に設定し、
9 * タグ名が元の形式（大文字小文字を区別）でハンドラに渡される様子を示します。
10 */
11function demonstrateXmlOptionCaseFolding(): void
12{
13    // 1. 新しいXMLパーサーを作成します。
14    $parser = xml_parser_create();
15    if (!$parser) {
16        echo "XMLパーサーの作成に失敗しました。\n";
17        return;
18    }
19
20    // 2. XML_OPTION_CASE_FOLDING オプションを false に設定します。
21    //    これにより、XMLデータ内のタグ名が元の形式のまま、大文字小文字を区別して処理されます。
22    //    もしこの設定を行わない（デフォルトの true）場合、すべてのタグ名は大文字に変換されて渡されます。
23    xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, false);
24
25    // 3. XML要素の開始タグが検出されたときに呼び出されるハンドラ関数を設定します。
26    //    この関数は、検出されたタグ名とその属性を出力します。
27    xml_set_element_handler(
28        $parser,
29        function ($parserResource, string $tagName, array $attributes) {
30            echo "開始タグ: " . $tagName . "\n";
31            foreach ($attributes as $key => $value) {
32                echo "  属性: " . $key . " = " . $value . "\n";
33            }
34        },
35        // 4. XML要素の終了タグが検出されたときに呼び出されるハンドラ関数を設定します。
36        function ($parserResource, string $tagName) {
37            echo "終了タグ: " . $tagName . "\n";
38        }
39    );
40
41    // 5. パースするサンプルXMLデータです。
42    //    タグ名に大文字小文字の混在を含めて、XML_OPTION_CASE_FOLDING の効果を確認します。
43    $xmlData = <<<XML
44<RootElement>
45  <childNode ID="1">
46    <SubItem Value="A"/>
47  </childNode>
48  <AnotherChildNode id="2"></AnotherChildNode>
49</RootElement>
50XML;
51
52    echo "--- XML_OPTION_CASE_FOLDING が false に設定された場合のパース結果 ---\n";
53
54    // 6. 用意したXMLデータをパースします。
55    if (!xml_parse($parser, $xmlData)) {
56        // パース中にエラーが発生した場合、エラー情報を出力します。
57        $errorCode = xml_get_error_code($parser);
58        $errorString = xml_error_string($errorCode);
59        $line = xml_get_current_line_number($parser);
60        echo "XMLパースエラー: " . $errorString . " (行: " . $line . ")\n";
61    }
62
63    // 7. XMLパーサーが使用していたリソースを解放します。
64    xml_parser_free($parser);
65}
66
67// サンプル関数を実行します。
68demonstrateXmlOptionCaseFolding();

XML_OPTION_CASE_FOLDINGは、PHPのXMLパーサーがXMLドキュメント内の要素名（タグ名）を処理する際、大文字小文字を区別するかどうかを設定するための定数です。この定数自体は引数を持たず、その値は整数型（int）として扱われます。

通常、このオプションのデフォルト値はtrue（真）であり、XMLパーサーはすべてのタグ名を大文字に変換して扱います。例えば、「<Tag>」と「<tag>」はどちらも「TAG」として処理されます。

サンプルコードでは、xml_parser_set_option関数を使って、このXML_OPTION_CASE_FOLDINGをfalse（偽）に明示的に設定しています。これにより、XMLパーサーはタグ名を元の形式、つまり大文字小文字を区別したままハンドラ関数に渡すようになります。コードはまず新しいXMLパーサーを作成し、その後このオプションを設定します。設定後、用意されたサンプルXMLデータをパースすることで、ハンドラ関数が「<RootElement>」や「<childNode>」といったタグ名を、入力された通りの大文字小文字で受け取っている様子を確認できます。この設定は、XMLデータが特定の大文字小文字の規則に従って作成されており、その規則を維持する必要がある場合に特に重要となります。

Copy
1<?php
2
3/**
4 * SimpleXMLとXPathを用いてXMLデータを処理し、XML_OPTION_CASE_FOLDING定数について説明します。
5 *
6 * XML_OPTION_CASE_FOLDINGは、通常、SAXパーサ（xml_parser_*関数群）においてXML要素名や属性名の
7 * 大文字/小文字変換（デフォルトでは大文字に変換）を制御するために使用される定数です。
8 * しかし、SimpleXMLはXMLドキュメントの要素名の大文字/小文字をそのまま保持し、
9 * XPathクエリも大文字/小文字を区別して要素を検索します。
10 * この関数では、SimpleXMLとXPathでの大文字/小文字の区別の重要性を示しつつ、
11 * XML_OPTION_CASE_FOLDING定数の値と、その一般的な役割を解説します。
12 */
13function processXmlWithSimpleXmlAndExplainCaseFolding(): void
14{
15    // 処理するXMLデータ
16    $xmlString = <<<XML
17<Root>
18    <Item id="1">
19        <Name>Apple</Name>
20        <price>100</price>
21    </Item>
22    <item id="2">
23        <Name>Banana</Name>
24        <Price>150</Price>
25    </item>
26    <Category>Fruits</Category>
27</Root>
28XML;
29
30    // SimpleXMLオブジェクトを作成
31    // エラーが発生した場合はfalseを返すため、確認が必要です。
32    libxml_use_internal_errors(true); // エラー情報を取得するために設定
33    $xml = simplexml_load_string($xmlString);
34
35    if ($xml === false) {
36        echo "XMLの読み込みに失敗しました。\n";
37        foreach (libxml_get_errors() as $error) {
38            echo "  " . trim($error->message) . "\n";
39        }
40        libxml_clear_errors(); // エラー情報をクリア
41        return;
42    }
43
44    echo "--- SimpleXML と XPath によるXML処理 ---\n";
45
46    // XPathで 'Item' 要素を検索（大文字 'I' で始まる要素）
47    // SimpleXMLはXML要素名の大文字小文字を保持します。
48    // XPathクエリも大文字小文字を区別するため、正確なケースで指定する必要があります。
49    $itemsUpperCase = $xml->xpath('//Root/Item');
50    echo "\n'//Root/Item' (大文字I) で検索された要素:\n";
51    if (!empty($itemsUpperCase)) {
52        foreach ($itemsUpperCase as $item) {
53            echo "- ID: " . (string)$item['id'] . ", 名前: " . (string)$item->Name . "\n";
54        }
55    } else {
56        echo "  見つかりませんでした。\n";
57    }
58
59    // XPathで 'item' 要素を検索（小文字 'i' で始まる要素）
60    $itemsLowerCase = $xml->xpath('//Root/item');
61    echo "\n'//Root/item' (小文字i) で検索された要素:\n";
62    if (!empty($itemsLowerCase)) {
63        foreach ($itemsLowerCase as $item) {
64            echo "- ID: " . (string)$item['id'] . ", 名前: " . (string)$item->Name . "\n";
65        }
66    } else {
67        echo "  見つかりませんでした。\n";
68    }
69
70    // XML_OPTION_CASE_FOLDING 定数について
71    echo "\n--- XML_OPTION_CASE_FOLDING 定数について ---\n";
72    echo "定数 XML_OPTION_CASE_FOLDING の値: " . XML_OPTION_CASE_FOLDING . " (int)\n";
73
74    // この定数は通常、`xml_parser_create()` などで作成されるXMLパーサーにおいて、
75    // 要素名や属性名が大文字に「折りたたまれる」（変換される）かどうかを制御します。
76    // デフォルト値は 1 (true) で、要素名は大文字に変換されます。
77    // しかし、SimpleXMLは内部でXMLドキュメントの構造と要素名の大文字小文字をそのまま保持するため、
78    // XML_OPTION_CASE_FOLDING定数はSimpleXMLの直接的な動作には影響しません。
79    // SimpleXMLやXPathを使用する際は、XMLデータ内の実際の要素名の大文字小文字に注意して
80    // プロパティアクセスやXPathクエリを作成する必要があります。
81}
82
83// 定義した関数を実行します。
84processXmlWithSimpleXmlAndExplainCaseFolding();

PHP 8で利用可能なXML_OPTION_CASE_FOLDINGは、XML処理に関する整数値の定数です。この定数には引数はなく、常に整数型（int）の値を返します。通常、この定数はSAXパーサ（xml_parser_createなどの関数群）において、XML要素名や属性名が大文字に「折りたたまれる」（変換される）かどうかを制御するために使用されます。デフォルトでは1（true）となっており、要素名は大文字に変換されるのが一般的です。

しかし、提供されたサンプルコードで示されているように、SimpleXMLはXMLドキュメントの要素名や属性名の大文字・小文字をそのまま保持します。また、SimpleXMLで利用するXPathクエリも、要素を検索する際に大文字・小文字を厳密に区別します。そのため、SimpleXMLやXPathを使用する際には、XMLデータ内の実際の要素名の大文字・小文字を正確に指定してアクセスする必要があります。XML_OPTION_CASE_FOLDING定数は、SimpleXMLの直接的な動作には影響しません。サンプルコードは、SimpleXMLとXPathにおける大文字・小文字の区別の重要性を示しつつ、この定数の一般的な役割について解説しています。