【PHP8.x】XMLReader::isDefaultプロパティの使い方

Copy
1<?php
2
3/**
4 * 指定されたXMLファイルから要素と属性を読み込み、
5 * 属性がDTDによってデフォルト値として設定されているかを確認します。
6 *
7 * システムエンジニアを目指す初心者向けに、XMLReaderのisDefaultプロパティの
8 * 使い方を簡潔に示します。
9 *
10 * @param string $filePath 処理するXMLファイルのパス。
11 * @return void
12 */
13function checkXmlAttributesForDefaults(string $filePath): void
14{
15    // XMLReaderオブジェクトを初期化します。
16    // XMLReaderは、XMLをストリームとして効率的に読み込むためのクラスです。
17    $reader = new XMLReader();
18
19    // 指定されたXMLファイルを開きます。
20    // ファイルが開けない場合はエラーメッセージを表示して終了します。
21    if (!$reader->open($filePath)) {
22        echo "エラー: XMLファイル '{$filePath}' を開けませんでした。\n";
23        return;
24    }
25
26    echo "XMLファイル '{$filePath}' の属性デフォルト値チェックを開始します。\n\n";
27
28    // XMLノードを一つずつ読み進めます。
29    // read()メソッドは、次のノードが存在する場合はtrueを、ファイル終端に達した場合はfalseを返します。
30    while ($reader->read()) {
31        // 現在のノードがXML要素（例: <item>）であるかを確認します。
32        if ($reader->nodeType === XMLReader::ELEMENT) {
33            echo "要素: " . $reader->name . "\n";
34
35            // その要素に属性が存在するかを確認します。
36            if ($reader->hasAttributes) {
37                // 最初の属性に移動します。
38                // これにより、属性に関する情報（名前、値、isDefaultなど）にアクセスできるようになります。
39                $reader->moveToFirstAttribute();
40
41                // すべての属性を繰り返し処理します。
42                // moveToNextAttribute()は、次の属性が存在すればtrueを返します。
43                do {
44                    // 現在の属性が、DTD（Document Type Definition）で定義されたデフォルト値であるかを確認します。
45                    // もし属性がXML内で明示的に指定されず、DTDでデフォルト値が設定されていた場合、
46                    // このプロパティはtrueを返します。
47                    $isDefault = $reader->isDefault;
48
49                    echo "  属性: " . $reader->name . " = '" . $reader->value . "'";
50                    echo " (DTDのデフォルト値? " . ($isDefault ? "はい" : "いいえ") . ")\n";
51
52                } while ($reader->moveToNextAttribute()); // 次の属性に移動します。
53            } else {
54                echo "  属性なし\n";
55            }
56        }
57    }
58
59    // XMLReaderを閉じ、関連するリソースを解放します。
60    $reader->close();
61    echo "\nXMLファイル '{$filePath}' のチェックが完了しました。\n";
62}
63
64// -----------------------------------------------------------
65// サンプル実行部分
66// -----------------------------------------------------------
67
68// このサンプルコードを単体で動作させるために、一時的なXMLファイルを作成します。
69$xmlFilePath = 'example_with_default_attributes.xml';
70
71// DTDでデフォルト値を持つ属性（status, priority）を定義したXMLコンテンツ。
72// <item id="2"/> の status 属性や <item id="4"/> の priority 属性はXMLで明示されていませんが、
73// DTDの定義によりデフォルト値が適用されます。
74$xmlContent = <<<XML
75<?xml version="1.0" encoding="UTF-8"?>
76<!DOCTYPE root [
77  <!ELEMENT root (item*)>
78  <!ELEMENT item EMPTY>
79  <!ATTLIST item
80      id CDATA #REQUIRED
81      status (active|inactive) "active"
82      priority CDATA "normal"
83  >
84]>
85<root>
86    <item id="1" status="active"/>
87    <item id="2"/> <!-- status属性はDTDのデフォルト値"active"が適用されます -->
88    <item id="3" status="inactive" priority="high"/>
89    <item id="4" priority="low"/> <!-- priority属性はDTDのデフォルト値"normal"が適用されます -->
90</root>
91XML;
92
93// XMLコンテンツをファイルに書き込みます。
94file_put_contents($xmlFilePath, $xmlContent);
95
96// 作成したXMLファイルを使って関数を実行します。
97checkXmlAttributesForDefaults($xmlFilePath);
98
99// プログラム実行後に一時ファイルを削除する場合は、以下の行のコメントを解除してください。
100// unlink($xmlFilePath);
101
102?>

XMLReader::isDefaultプロパティは、PHPのXMLReaderクラスに属し、XMLドキュメント内で現在読み込んでいる属性が、DTD（Document Type Definition）によって定義されたデフォルト値であるかどうかを判断するために使用されます。XMLReaderは、大きなXMLファイルを効率的に処理するために、XMLをストリーム形式で読み込むことができるクラスです。

このプロパティは引数を取らず、戻り値としてブール値（trueまたはfalse）を返します。具体的には、もし属性がXMLファイル内で明示的に指定されておらず、DTDでデフォルト値が設定されている場合にtrueを返します。逆に、属性がXMLファイル内で明示的に記述されている場合は、たとえその値がDTDのデフォルト値と同じであったとしてもfalseを返します。

サンプルコードでは、まずXMLReaderオブジェクトを初期化し、指定されたXMLファイルを開きます。ファイルが開けない場合はエラーを出力します。次に、read()メソッドでXMLノードを順番に読み進め、要素ノードに到達するとその要素に存在する属性を一つずつチェックします。moveToFirstAttribute()とmoveToNextAttribute()メソッドを使って各属性に移動し、$reader->isDefaultにアクセスすることで、その属性がDTDのデフォルト値であるかを確認し、結果を表示しています。これにより、XMLの解析時に属性がどのように解釈されているかを詳細に把握できます。