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

Copy
1<?php
2
3/**
4 * XML_ATTRIBUTE_NMTOKEN 定数とXML属性の処理例。
5 *
6 * NMTOKEN (Name Token) はXMLの属性型の一つで、XML 1.0 の Name トークン規則に合致する文字列を指します。
7 * これは、文字、数字、ハイフン、アンダースコア、コロン、ピリオドで構成され、空白を含まない文字列です。
8 * XML_ATTRIBUTE_NMTOKEN 定数は、libxml内部でこのNMTOKEN型の属性を識別するために使用される値です。
9 * PHPの標準的なXML処理ライブラリ（SimpleXMLElementなど）では、
10 * この定数を直接使用して属性の型を検証するAPIは一般的ではありませんが、
11 * 属性の値を扱う際にNMTOKENの規則を意識することは重要です。
12 */
13
14// サンプルXMLデータ
15$xmlString = <<<XML
16<root>
17    <item id="item1" status="active-A1" type="valid-NMTOKEN">
18        これはテストアイテムです。
19    </item>
20    <item id="item2" status="inactive" type="invalid NMTOKEN!">
21        別のアイテムです。
22    </item>
23    <item id="item3" status="pending" type="123.nmtoken-ok">
24        三つ目のアイテムです。
25    </item>
26</root>
27XML;
28
29// SimpleXMLElement を使用してXMLをパースし、属性を扱います。
30// キーワードの "@attributes" に関連する処理です。
31try {
32    $xml = new SimpleXMLElement($xmlString);
33
34    echo "--- XML属性の処理例 ---" . PHP_EOL;
35
36    foreach ($xml->item as $item) {
37        // SimpleXMLElementでは、属性に配列のようにアクセスできます。
38        $itemId = (string)$item['id'];
39        $itemType = (string)$item['type'];
40
41        echo "アイテムID: '{$itemId}', 'type'属性値: '{$itemType}'" . PHP_EOL;
42
43        // PHPで属性値がNMTOKENの規則に従っているか確認するには、正規表現を使用するのが一般的です。
44        // NMTOKENは、文字 (\p{L})、数字 (\p{N})、アンダースコア (_)、ハイフン (-)、ピリオド (.)、コロン (:) のみを含み、
45        // 空白を含まない文字列です。
46        $nmtokenPattern = '/^[\p{L}\p{N}_\-.:]+$/u';
47
48        if (preg_match($nmtokenPattern, $itemType)) {
49            echo "  -> この 'type' 属性値はNMTOKENの規則に合致しています。" . PHP_EOL;
50        } else {
51            echo "  -> この 'type' 属性値はNMTOKENの規則に合致していません。" . PHP_EOL;
52        }
53        echo PHP_EOL;
54    }
55
56} catch (Exception $e) {
57    echo "XMLのパース中にエラーが発生しました: " . $e->getMessage() . PHP_EOL;
58    exit(1);
59}
60
61// XML_ATTRIBUTE_NMTOKEN 定数の値を確認します。
62// この定数はXMLパーサーの内部でNMTOKEN属性を識別する際に使用されます。
63echo "--- XML_ATTRIBUTE_NMTOKEN 定数の確認 ---" . PHP_EOL;
64echo "XML_ATTRIBUTE_NMTOKEN の値: " . XML_ATTRIBUTE_NMTOKEN . PHP_EOL;
65

XML_ATTRIBUTE_NMTOKENは、PHPがXMLを処理する際に内部で利用する定数です。これは、XMLの属性型の一つであるNMTOKEN（Name Token）という種類の属性を識別するための整数値です。NMTOKENとは、文字、数字、ハイフン、アンダースコア、コロン、ピリオドで構成され、空白を含まない特定のルールに沿った文字列を指します。この定数には引数はなく、XML処理の内部で使用される整数（int）の値を返します。

サンプルコードでは、まずSimpleXMLElementというPHPの機能を使ってXMLデータを読み込んでいます。SimpleXMLElementを使うと、$item['id']のように配列のキーのような形式で、XML要素の属性（@attributesとして扱われる部分）に簡単にアクセスできます。コードでは、各アイテムのtype属性の値を取り出し、それがNMTOKENの規則に合致しているかどうかをPHPの正規表現を使って確認する例を示しています。これは、XMLの属性値が期待通りの形式であるかを検証する際によく用いられる方法です。最後に、XML_ATTRIBUTE_NMTOKEN定数にどのような整数値が設定されているかを出力し、その存在を確認しています。

Copy
1<?php
2
3/**
4 * XML_ATTRIBUTE_NMTOKEN定数を使用して、XML属性の型を識別するサンプルコード。
5 *
6 * この定数は、XML属性がNMTOKEN (Name Token) 型であることを示す整数値です。
7 * NMTOKENはXMLの属性値の型の一つで、アルファベット、数字、'.'、'-'、'_'、':'
8 * のみで構成され、スペースを含まない文字列を表します。
9 *
10 * PHPのXMLパーサー（SAX）では、`xml_set_attribute_handler` で設定する
11 * コールバック関数に属性の型が渡されます。ただし、DTDやXMLスキーマが提供されない限り、
12 * ほとんどの属性は `XML_ATTRIBUTE_CDATA` (CDATA型) として扱われます。
13 * この例では、`XML_ATTRIBUTE_NMTOKEN` 定数の値と、属性ハンドラで取得できる属性型を比較します。
14 *
15 * @param string $xmlString 処理するXML文字列
16 */
17function processXmlWithAttributeTypeCheck(string $xmlString): void
18{
19    echo "--- XML Attribute Type Check (NMTOKEN) ---\n";
20    echo "Value of XML_ATTRIBUTE_NMTOKEN: " . XML_ATTRIBUTE_NMTOKEN . "\n\n";
21
22    // XMLパーサーを作成します。SAXパーサーはXMLをイベント駆動で処理します。
23    $parser = xml_parser_create();
24
25    // 属性ハンドラを設定します。XMLドキュメント内で属性が見つかるたびに、
26    // このコールバック関数が呼び出されます。
27    // コールバック関数には、パーサー、要素名、属性の連想配列が渡されます。
28    // 属性の配列は ['属性名' => ['属性値', 属性型ID]] の形式です。
29    xml_set_attribute_handler($parser, function ($parser, $elementName, $attributes) {
30        echo "Element: <" . $elementName . ">\n";
31        foreach ($attributes as $attrName => $attrInfo) {
32            $attrValue = $attrInfo[0]; // 属性値を取得
33            $attrType = $attrInfo[1];  // 属性型ID (例: XML_ATTRIBUTE_CDATA, XML_ATTRIBUTE_NMTOKEN など) を取得
34
35            echo "  Attribute: " . $attrName . "=\"{$attrValue}\"\n";
36            echo "    Detected Type ID: " . $attrType;
37
38            // 検出された属性型IDが XML_ATTRIBUTE_NMTOKEN 定数と一致するかをチェックします。
39            // DTDやXMLスキーマが提供されないXMLでは、通常、属性はXML_ATTRIBUTE_CDATAとして識別されます。
40            if ($attrType === XML_ATTRIBUTE_NMTOKEN) {
41                echo " (Matches XML_ATTRIBUTE_NMTOKEN!)\n";
42            } elseif ($attrType === XML_ATTRIBUTE_CDATA) {
43                echo " (Detected as XML_ATTRIBUTE_CDATA)\n";
44            } else {
45                echo " (Other type ID)\n";
46            }
47        }
48        echo "\n"; // 各要素の属性表示後に改行
49    });
50
51    // XML文字列をパースします。エラーが発生した場合はメッセージを表示します。
52    if (!xml_parse($parser, $xmlString)) {
53        $errorCode = xml_get_error_code($parser);
54        $errorMessage = xml_error_string($errorCode);
55        $lineNumber = xml_get_current_line_number($parser);
56        echo "XML Parse Error: {$errorMessage} at line {$lineNumber}\n";
57    }
58
59    // パーサーによって使用されたリソースを解放します。
60    xml_parser_free($parser);
61
62    echo "--- End of processing ---\n";
63}
64
65// サンプルXML文字列を定義します。
66// このXMLにはDTDやXMLスキーマが指定されていないため、
67// PHPのXMLパーサーはほとんどの属性をXML_ATTRIBUTE_CDATAとして識別する傾向があります。
68// これは、`XML_ATTRIBUTE_NMTOKEN` が直接検出されることは稀であることを意味しますが、
69// 定数の比較方法を示すための良い例となります。
70$sampleXml = <<<XML
71<data>
72    <item id="123" name="sample-item" token="some_token-1.0" description="A sample item with various attributes.">
73        <property key="color" value="red"/>
74    </item>
75    <settings active="true"/>
76</data>
77XML;
78
79// 定義した関数を実行し、XML属性の型をチェックします。
80processXmlWithAttributeTypeCheck($sampleXml);

XML_ATTRIBUTE_NMTOKENは、PHPのXML拡張機能で定義されている定数で、XML属性がNMTOKEN（Name Token）型であることを示す整数値を保持しています。NMTOKEN型とは、XMLの属性値としてアルファベット、数字、'.'、'-'、'_'、':'といった文字のみで構成され、スペースを含まない文字列を表す型です。この定数には引数はなく、常にその型の識別子となる整数値を返します。

このサンプルコードは、SAX（Simple API for XML）パーサーを用いてXMLドキュメントを解析し、属性の型を識別する手順を示しています。xml_parser_create関数でパーサーを初期化し、xml_set_attribute_handlerで属性が見つかるたびに実行されるコールバック関数を設定します。このコールバック関数には、各属性の名前、その値、そしてPHPのXMLパーサーが識別した属性の型IDが渡されます。コード内では、この渡された型IDがXML_ATTRIBUTE_NMTOKEN定数の値と一致するかどうかを比較しています。

通常、XMLドキュメントにDTD（Document Type Definition）やXMLスキーマが明示的に指定されていない場合、PHPのSAXパーサーはほとんどの属性をXML_ATTRIBUTE_CDATA（文字データ型）として識別します。そのため、XML_ATTRIBUTE_NMTOKENが直接検出されることは稀ですが、XMLの属性定義が厳密にされている場合に、この定数を使ってNMTOKEN型をプログラム的に識別することが可能です。最終的にxml_parseでXML文字列を処理し、xml_parser_freeでパーサーのリソースを解放することで、メモリ管理も行っています。