【PHP8.x】DOMDocument::xmlStandaloneプロパティの使い方

Copy
1<?php
2
3/**
4 * XMLデータをSAXパーサーで処理するクラスの例。
5 * xml_set_element_handler 関数を使用して、要素の開始と終了を処理します。
6 * システムエンジニアを目指す初心者の方にも、XMLをイベントドリブンで解析する
7 * 基本的な方法を理解してもらえるよう、簡潔にまとめています。
8 */
9class XmlProcessor
10{
11    /**
12     * XMLパーサーリソース。
13     * @var resource|null
14     */
15    private $parser;
16
17    /**
18     * XMLデータをSAX方式でパースします。
19     *
20     * @param string $xmlData パースするXML文字列。
21     * @return bool 成功した場合はtrue、失敗した場合はfalse。
22     */
23    public function parse(string $xmlData): bool
24    {
25        // XMLパーサーを作成します。
26        // xml_parser_create() は、XMLパーサーの新しいインスタンスを返します。
27        $this->parser = xml_parser_create();
28        if ($this->parser === false) {
29            echo "エラー: XMLパーサーの作成に失敗しました。\n";
30            return false;
31        }
32
33        // XMLパーサーのオプションを設定します。
34        // XML_OPTION_CASE_FOLDING を 0 に設定すると、要素名と属性名の大文字・小文字を区別します。
35        xml_parser_set_option($this->parser, XML_OPTION_CASE_FOLDING, 0);
36
37        // 要素の開始と終了を処理するハンドラ関数を設定します。
38        // xml_set_element_handler() は、要素の開始タグと終了タグが検出されたときに
39        // 呼び出される関数を指定します。
40        // ここでは、このクラス内のプライベートメソッドをコールバックとして指定しています。
41        xml_set_element_handler(
42            $this->parser,
43            [$this, 'startElementHandler'], // 開始要素ハンドラ: 開始タグ検出時に呼び出される
44            [$this, 'endElementHandler']    // 終了要素ハンドラ: 終了タグ検出時に呼び出される
45        );
46
47        // XMLデータをパースします。
48        // xml_parse() は、与えられたXMLデータをパースし、設定されたハンドラを呼び出します。
49        // 成功した場合は true、失敗した場合は false を返します。
50        $success = xml_parse($this->parser, $xmlData);
51
52        if (!$success) {
53            // パースエラーが発生した場合、エラー情報を取得して表示します。
54            $errorCode = xml_get_error_code($this->parser);
55            $errorString = xml_error_string($errorCode);
56            $line = xml_get_current_line_number($this->parser);
57            $column = xml_get_current_column_number($this->parser);
58            echo "エラー: XMLパースエラーが発生しました: {$errorString} (コード: {$errorCode}) at line {$line}, column {$column}\n";
59        }
60
61        // 使用したXMLパーサーリソースを解放します。
62        xml_parser_free($this->parser);
63        $this->parser = null; // リソースを解放後、プロパティをnullに設定
64
65        return $success;
66    }
67
68    /**
69     * XML要素の開始タグが検出されたときに呼び出されるハンドラ関数。
70     *
71     * @param resource $parser XMLパーサーリソース。
72     * @param string $name 要素名。
73     * @param array $attrs 要素の属性の連想配列。
74     * @return void
75     */
76    private function startElementHandler($parser, string $name, array $attrs): void
77    {
78        echo "要素開始: <{$name}>";
79        if (!empty($attrs)) {
80            // 属性が存在する場合、それらを表示します。
81            echo " (属性: " . json_encode($attrs, JSON_UNESCAPED_UNICODE | JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT) . ")";
82        }
83        echo "\n";
84    }
85
86    /**
87     * XML要素の終了タグが検出されたときに呼び出されるハンドラ関数。
88     *
89     * @param resource $parser XMLパーサーリソース。
90     * @param string $name 要素名。
91     * @return void
92     */
93    private function endElementHandler($parser, string $name): void
94    {
95        echo "要素終了: </{$name}>\n";
96    }
97}
98
99// --- サンプルコードの実行例 ---
100
101// 1. パースするXMLデータを文字列として定義します。
102$sampleXml = <<<XML
103<?xml version="1.0" encoding="UTF-8"?>
104<bookstore>
105    <book category="cooking">
106        <title lang="en">Everyday Italian</title>
107        <author>Giada De Laurentiis</author>
108        <year>2005</year>
109        <price>30.00</price>
110    </book>
111    <book category="children">
112        <title lang="en">Harry Potter</title>
113        <author>J. K. Rowling</author>
114        <year>2005</year>
115        <price>29.99</price>
116    </book>
117</bookstore>
118XML;
119
120// XmlProcessorクラスのインスタンスを作成します。
121$processor = new XmlProcessor();
122
123echo "--- 有効なXMLのパース開始 ---\n";
124// XMLデータをパースし、成功したか失敗したかを表示します。
125if ($processor->parse($sampleXml)) {
126    echo "--- 有効なXMLのパース成功 ---\n";
127} else {
128    echo "--- 有効なXMLのパース失敗 ---\n";
129}
130
131// 2. 意図的にエラーを含むXMLデータを用意し、パース失敗の例を示します。
132$invalidXml = <<<XML
133<?xml version="1.0"?>
134<root>
135    <item>Value</item  <!-- ここに閉じタグの '>' がありません -->
136    <another_item/>
137</root>
138XML;
139
140echo "\n--- 無効なXMLのパース開始 ---\n";
141if ($processor->parse($invalidXml)) {
142    echo "--- 無効なXMLのパース成功 ---\n";
143} else {
144    echo "--- 無効なXMLのパース失敗 ---\n";
145}

PHPでXMLデータをSAX（Simple API for XML）方式で解析する基本的な方法を示すサンプルコードです。SAXパーサーは、XMLファイルを先頭から順に読み込み、要素の開始や終了といったイベントが発生するたびに、あらかじめ登録された関数（ハンドラ）を呼び出して処理を進める、イベントドリブンな解析手法です。

このコードの核となるのはxml_set_element_handler()関数です。この関数は、XMLパーサーリソースに対して、要素の開始タグと終了タグが検出されたときにそれぞれ呼び出すコールバック関数を設定します。第一引数には作成済みのXMLパーサーリソースを、第二引数には開始要素ハンドラを、第三引数には終了要素ハンドラの関数名（またはメソッド）を指定します。サンプルコードでは、XmlProcessorクラス内のstartElementHandlerメソッドが開始タグを、endElementHandlerメソッドが終了タグを処理するよう登録されています。

startElementHandlerメソッドは、XMLパーサーリソース、要素名、およびその属性の連想配列を引数として受け取り、開始タグ検出時の処理を行います。一方、endElementHandlerメソッドは、XMLパーサーリソースと要素名を引数として受け取り、終了タグ検出時の処理を行います。

parseメソッドの内部では、まずxml_parser_create()でパーサーを作成し、xml_set_element_handler()でハンドラを設定した後、xml_parse()関数にXML文字列を渡して実際の解析を実行します。xml_parse()は解析に成功すればtrue、失敗すればfalseを返します。失敗時にはxml_get_error_code()などで詳細なエラー情報を取得可能です。処理の完了後にはxml_parser_free()でパーサーリソースを解放し、リソース管理を行います。

Copy
1<?php
2
3/**
4 * DOMDocument の xmlStandalone プロパティの動作を示すサンプルコードです。
5 *
6 * xmlStandalone プロパティは、XML宣言の 'standalone' 属性 (例: <?xml ... standalone="yes"?>)
7 * を制御するために使用されます。この属性は、外部のマークアップ宣言に依存せずに
8 * XMLドキュメント自体が完全に独立しているかどうかを示します。
9 *
10 * システムエンジニアを目指す初心者の方にも理解しやすいように、
11 * XMLドキュメントの基本的な作成からプロパティの設定、
12 * そして結果として出力されるXMLの内容までを具体的に示します。
13 */
14function demonstrateXmlStandaloneProperty(): void
15{
16    // 1. DOMDocument オブジェクトを初期化します。
17    // '1.0' はXMLのバージョン、'UTF-8' はエンコーディングを指定します。
18    $dom = new DOMDocument('1.0', 'UTF-8');
19
20    // 生成されるXML出力を見やすくするために、整形を有効にします。
21    $dom->formatOutput = true;
22
23    // 2. XMLドキュメントにルート要素とサブ要素を追加します。
24    $root = $dom->createElement('data');
25    $dom->appendChild($root);
26    $item = $dom->createElement('message', 'Hello, XML Standalone!');
27    $root->appendChild($item);
28
29    // 3. xmlStandalone プロパティの値を変更し、それぞれのXML出力を確認します。
30
31    // --- ケース1: xmlStandalone = true (standalone="yes") ---
32    // XML宣言に standalone="yes" が含まれます。これは、このXMLドキュメントが
33    // 外部DTDなどに依存せず単独で完結していることを示します。
34    echo "--- xmlStandalone を true に設定した場合 (standalone=\"yes\") ---\n";
35    $dom->xmlStandalone = true;
36    echo "現在の xmlStandalone の値: " . ($dom->dom->xmlStandalone ? 'true' : 'false') . "\n";
37    echo "生成されたXML:\n";
38    echo $dom->saveXML(); // DOMDocumentオブジェクトのXML表現を文字列として取得します。
39    echo "\n";
40
41    // --- ケース2: xmlStandalone = false (standalone="no") ---
42    // XML宣言に standalone="no" が含まれます。これは、このXMLドキュメントが
43    // 外部のマークアップ宣言に依存している可能性があることを示します。
44    echo "--- xmlStandalone を false に設定した場合 (standalone=\"no\") ---\n";
45    $dom->xmlStandalone = false;
46    echo "現在の xmlStandalone の値: " . ($dom->dom->xmlStandalone ? 'true' : 'false') . "\n";
47    echo "生成されたXML:\n";
48    echo $dom->saveXML();
49    echo "\n";
50
51    // --- ケース3: xmlStandalone = null (standalone属性なし) ---
52    // null を設定すると、XML宣言から 'standalone' 属性が省略されます。
53    // これは、PHPのDOMDocumentにおけるデフォルトの挙動でもあります。
54    echo "--- xmlStandalone を null に設定した場合 (standalone属性なし) ---\n";
55    $dom->xmlStandalone = null;
56    // null の表示は var_export() 関数がより正確で、値の型も示します。
57    echo "現在の xmlStandalone の値: " . var_export($dom->dom->xmlStandalone, true) . "\n";
58    echo "生成されたXML:\n";
59    echo $dom->saveXML();
60    echo "\n";
61}
62
63// 上記の関数を実行して、DOMDocument::xmlStandalone プロパティの動作を確認します。
64demonstrateXmlStandaloneProperty();

このサンプルコードは、PHPのDOMDocumentクラスが持つxmlStandaloneプロパティの働きを示しています。このプロパティは、XMLドキュメントの先頭にあるXML宣言（例: <?xml version="1.0" encoding="UTF-8" standalone="yes"?>）に含まれるstandalone属性の値を制御するために使用されます。

standalone属性は、そのXMLドキュメントが外部のマークアップ宣言（例えばDTD）に依存せずに、単独で完全に独立しているかどうかを示します。 xmlStandaloneプロパティにtrueを設定すると、XML宣言にはstandalone="yes"が出力され、ドキュメントが独立していることを明示します。 一方、falseを設定するとstandalone="no"が出力され、外部に依存している可能性があることを示します。 また、nullを設定した場合は、XML宣言からstandalone属性自体が省略されます。これはPHPにおけるDOMDocumentのデフォルトの挙動でもあります。

このプロパティから値を取得する際の戻り値はboolまたはnullで、現在のstandalone属性の状態を正確に確認することができます。この機能により、XMLドキュメントの外部依存に関する情報を細かく制御し、要件に合わせたXMLファイルを生成することが可能です。