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

Copy
1<?php
2
3/**
4 * Dom\XMLDocument クラスの xmlStandalone プロパティの使用例を示します。
5 * このプロパティは、XML宣言に standalone="yes" または standalone="no" が
6 * 含まれているかどうかの状態を真偽値で返します。
7 *
8 * @link https://www.php.net/manual/ja/class.dom-xmldocument.php
9 */
10function demonstrateXmlStandaloneProperty(): void
11{
12    // Dom\XMLDocument インスタンスを新規作成
13    $doc = new Dom\XMLDocument('1.0', 'UTF-8');
14    $doc->formatOutput = true; // 出力を見やすく設定
15
16    // 1. standalone="yes" を含むXMLをロードし、xmlStandaloneの値を表示
17    $xmlWithStandaloneYes = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>' . "\n"
18                          . '<root><item>Hello</item></root>';
19    $doc->loadXML($xmlWithStandaloneYes);
20    echo "--- XML with standalone=\"yes\" ---\n";
21    echo $doc->saveXML();
22    echo "xmlStandalone: " . ($doc->xmlStandalone ? 'true' : 'false') . "\n\n";
23
24    // 2. standalone="no" を含むXMLをロードし、xmlStandaloneの値を表示
25    $xmlWithStandaloneNo = '<?xml version="1.0" encoding="UTF-8" standalone="no"?>' . "\n"
26                         . '<root><item>World</item></root>';
27    $doc->loadXML($xmlWithStandaloneNo);
28    echo "--- XML with standalone=\"no\" ---\n";
29    echo $doc->saveXML();
30    echo "xmlStandalone: " . ($doc->xmlStandalone ? 'true' : 'false') . "\n\n";
31
32    // 3. standalone属性を含まないXMLをロードし、xmlStandaloneの値を表示
33    $xmlWithoutStandalone = '<?xml version="1.0" encoding="UTF-8"?>' . "\n"
34                          . '<root><item>PHP</item></root>';
35    $doc->loadXML($xmlWithoutStandalone);
36    echo "--- XML without standalone attribute ---\n";
37    echo $doc->saveXML();
38    echo "xmlStandalone: " . ($doc->xmlStandalone ? 'true' : 'false') . "\n\n";
39
40    // 4. 新規作成したDom\XMLDocumentのxmlStandaloneの値を表示
41    $newDoc = new Dom\XMLDocument('1.0', 'UTF-8');
42    $newDoc->appendChild($newDoc->createElement('data'));
43    echo "--- Newly created Dom\\XMLDocument ---\n";
44    echo $newDoc->saveXML();
45    echo "xmlStandalone: " . ($newDoc->xmlStandalone ? 'true' : 'false') . "\n";
46}
47
48// サンプル関数の実行
49demonstrateXmlStandaloneProperty();

PHP 8のDom\XMLDocumentクラスに属するxmlStandaloneプロパティは、XMLドキュメントのXML宣言に含まれるstandalone属性の状態を真偽値（bool）で示します。このプロパティは引数を取りません。

具体的には、XMLドキュメントのXML宣言にstandalone="yes"が記述されている場合、このプロパティはtrueを返します。これは、XMLドキュメントが外部の文書型定義（DTD）に依存せず、単独で処理可能であることを意味します。

反対に、XML宣言にstandalone="no"が記述されている場合、またはstandalone属性自体が含まれていない場合は、xmlStandaloneプロパティはfalseを返します。standalone属性がない場合は、XML仕様によりデフォルトでnoとして扱われます。

サンプルコードでは、standalone="yes"、standalone="no"、そしてstandalone属性を含まない3種類のXMLをそれぞれ読み込み、xmlStandaloneプロパティがどのように変化するかを示しています。また、新しくDom\XMLDocumentインスタンスを作成した直後の初期値も確認しており、この場合はfalseを返します。このプロパティを使用することで、XMLドキュメントが外部定義に依存しているか否かをプログラムで判別できます。

Copy
1<?php
2
3declare(strict_types=1);
4
5use Dom\XMLDocument;
6
7/**
8 * 指定されたXML文字列を解析し、そのXMLが外部リソース（DTDなど）に依存しない
9 * 「スタンドアロン」として宣言されているかを確認します。
10 *
11 * @param string $xmlString 解析するXML文字列。XML宣言に standalone="yes" が含まれるかを調べます。
12 * @return void
13 */
14function checkXmlStandaloneStatus(string $xmlString): void
15{
16    echo "--- XMLスタンドアロンステータスチェック ---" . PHP_EOL;
17    echo "対象XML文字列:\n" . $xmlString . PHP_EOL;
18
19    try {
20        // Dom\XMLDocument の新しいインスタンスを作成します。
21        // これはPHP 8から導入された新しいDOM拡張機能です。
22        $document = new XMLDocument();
23
24        // XML文字列をロードします。
25        // XMLの構文に問題がある場合は例外がスローされる可能性があります。
26        $document->loadXML($xmlString);
27
28        // xmlStandalone プロパティの値を取得します。
29        // このプロパティは、XML宣言に 'standalone="yes"' が含まれている場合に true を返します。
30        // 'standalone="no"' が含まれている場合や、standalone属性自体が存在しない場合は false を返します。
31        $isStandalone = $document->xmlStandalone;
32
33        echo "結果: xmlStandalone は " . ($isStandalone ? 'true' : 'false') . " です。" . PHP_EOL;
34        if ($isStandalone) {
35            echo "このXMLは、外部のDTDなどに依存しない「スタンドアロン文書」として宣言されています。" . PHP_EOL;
36        } else {
37            echo "このXMLは、外部のDTDなどに依存する可能性がある、またはそのように宣言されていません。" . PHP_EOL;
38        }
39
40    } catch (\Throwable $e) {
41        // XMLの構文エラーなど、解析中に発生した例外を捕捉します。
42        echo "エラー: XMLの解析中に問題が発生しました: " . $e->getMessage() . PHP_EOL;
43    }
44    echo PHP_EOL;
45}
46
47// サンプルXML文字列を定義します。
48// このXMLは、XML宣言に 'standalone="yes"' を含んでいます。
49// PhpStormなどのIDEでXMLを扱う際、この属性はXMLの自己完結性を示す重要な情報です。
50$sampleXml = <<<XML
51<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
52<config>
53    <setting name="debugMode">true</setting>
54    <feature name="betaFeatures" enabled="false"/>
55</config>
56XML;
57
58// 定義した関数を呼び出し、XMLのスタンドアロンステータスをチェックします。
59checkXmlStandaloneStatus($sampleXml);

このPHPコードは、XML文書が外部リソースに依存しない「スタンドアロン」として宣言されているかを確認する方法を示しています。PHP 8から導入されたDom\XMLDocumentクラスを使用し、指定されたXML文字列をロードして解析します。

まず、解析したいXML文字列をXMLDocumentのインスタンスにloadXML()メソッドで読み込みます。XMLの構文に問題がある場合は例外がスローされる可能性があるため、try-catchブロックでエラーを捕捉し、安全に処理を行います。

XMLのロードが成功すると、$document->xmlStandaloneプロパティにアクセスすることで、そのXMLがスタンドアロン宣言されているかどうかの真偽値（bool）を取得できます。このプロパティは引数を取らず、XML宣言（<?xml ...?>）の中にstandalone="yes"が含まれている場合にtrueを返し、それ以外の場合（standalone="no"またはstandalone属性自体が存在しない場合）はfalseを返します。

この情報は、XMLが外部のDTDなどに依存せず自己完結的であるか、またはその可能性があるかをプログラムで判断するために利用できます。PhpStormなどの統合開発環境（IDE）でXMLファイルを扱う際、XMLの自己完結性は、ファイルの検証や処理の振る舞いを理解する上で重要な要素となります。