【PHP8.x】DOMEntity::systemIdプロパティの使い方

Copy
1<?php
2
3/**
4 * DOMEntity::systemId プロパティの利用例を示します。
5 *
6 * このプロパティは、XML ドキュメントの DTD (Document Type Definition) で定義される
7 * 外部実体 (EXTERNAL ENTITY) のシステム識別子 (通常は URI やファイルパス) を取得するために使用されます。
8 *
9 * PHP の `system()` 関数や Unix/Linux コマンドの `id` とは概念的に異なります。
10 * ここでは、systemId の値に 'id' という文字列を含む例を使用しています。
11 *
12 * @return void
13 */
14function demonstrateDomEntitySystemId(): void
15{
16    // 外部実体を参照する DTD を含む XML ドキュメントを作成します。
17    // <!ENTITY myIdEntity SYSTEM "resource_with_id.xml">
18    // ここで "resource_with_id.xml" が systemId に該当します。
19    // このファイルは実際に存在する必要はありません。
20    $xmlString = <<<XML
21<?xml version="1.0" encoding="UTF-8"?>
22<!DOCTYPE root [
23  <!ENTITY myIdEntity SYSTEM "resource_with_id.xml">
24  <!ENTITY anotherPublicEntity PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
25]>
26<root>
27  <data>&myIdEntity;</data>
28</root>
29XML;
30
31    $dom = new DOMDocument();
32    // 外部実体のロードを有効にします。
33    // 注意: 信頼できないXMLソースからの外部実体ロードはセキュリティリスクとなる可能性があります。
34    $dom->resolveExternals = true;
35    
36    // XML 文字列を DOM オブジェクトにロードします。
37    if (!$dom->loadXML($xmlString)) {
38        echo "エラー: XML のロードに失敗しました。\n";
39        return;
40    }
41
42    // ドキュメントタイプノード (DTD 情報を含む) を取得します。
43    $doctype = $dom->doctype;
44
45    if ($doctype && $doctype->entities) {
46        echo "DTD エンティティの検索結果:\n";
47        foreach ($doctype->entities as $entity) {
48            // DOMEntity 型のオブジェクトであることを確認します。
49            if ($entity instanceof DOMEntity) {
50                echo "  エンティティ名: " . $entity->nodeName . "\n";
51                // systemId プロパティは外部実体のシステム識別子 (string|null) を返します。
52                echo "  システムID:    " . ($entity->systemId ?? "N/A (システムIDなし)") . "\n";
53                // publicId も存在する場合、合わせて出力します。
54                echo "  パブリックID:  " . ($entity->publicId ?? "N/A (パブリックIDなし)") . "\n";
55                echo "-----------------------------------\n";
56            }
57        }
58    } else {
59        echo "XML に DTD またはエンティティが見つかりませんでした。\n";
60    }
61}
62
63// 関数を実行して DOMEntity::systemId の動作を確認します。
64demonstrateDomEntitySystemId();

DOMEntity::systemIdプロパティは、XMLドキュメントのDTD（Document Type Definition）内で定義される外部実体のシステム識別子を取得するために使用されます。外部実体とは、XMLドキュメントの外部に存在するリソースのことで、システム識別子はそのリソースのURIやファイルパスを示します。このプロパティは引数を取らず、識別子の文字列（string）または、定義されていない場合はnullを返します。

本プロパティは、PHPのsystem()関数やUnix/Linuxコマンドのidとは概念的に異なります。サンプルコードでは、DTDにresource_with_id.xmlというシステム識別子を持つ外部実体を定義し、DOMDocumentを通じてそのエンティティのsystemIdを取得する流れを示しています。

XMLを読み込む際にDOMDocument::resolveExternalsプロパティをtrueに設定すると、外部実体のロードが有効になりますが、信頼できないXMLソースからの外部実体ロードはセキュリティリスクとなる可能性があるため注意が必要です。DOMEntity::systemIdは、XMLが参照する外部リソースの情報をプログラムで扱う際に活用できます。

Copy
1<?php
2
3/**
4 * DOMEntity::$systemId プロパティの利用例を示します。
5 * このプロパティは、XML DTD (Document Type Definition) で宣言された
6 * 外部エンティティのシステム識別子 (System Identifier) を取得するために使用されます。
7 * システム識別子は通常、外部リソースへのURIやパスを示します。
8 *
9 * 注: キーワードとして 'systemd' が指定されましたが、
10 * DOMEntity::$systemId は Linux のサービス管理システム 'systemd' とは直接的な関連はありません。
11 * ここでいう 'systemId' は XML ドキュメントのコンテキストにおける外部リソースの識別子を指します。
12 *
13 * @return void
14 */
15function demonstrateDomEntitySystemId(): void
16{
17    // XML ドキュメントと DTD を準備します。
18    // ここでは、"external_data" という名前の外部エンティティを宣言し、
19    // そのシステム識別子として "http://example.com/data/config.xml" を指定しています。
20    $xmlString = <<<XML
21<!DOCTYPE root [
22  <!ENTITY external_data SYSTEM "http://example.com/data/config.xml">
23  <!ENTITY internal_message "This is an internal message.">
24]>
25<root>
26    <message>&internal_message;</message>
27    <!-- &external_data; は解析時に外部リソースの内容で置き換えられます -->
28</root>
29XML;
30
31    $dom = new DOMDocument();
32    // DTD の情報（エンティティなど）をロードするために LIBXML_DTDLOAD を使用します。
33    // LIBXML_DTDATTR は DTD で定義されたデフォルト属性を適用するために使用されます。
34    $dom->loadXML($xmlString, LIBXML_DTDLOAD | LIBXML_DTDATTR);
35
36    // ドキュメントタイプ (DOCTYPE) を取得します。
37    $doctype = $dom->doctype;
38
39    if ($doctype) {
40        echo "XML ドキュメントに DTD が見つかりました。\n";
41        // DTD からエンティティマップ (DOMNamedNodeMap) を取得します。
42        $entities = $doctype->entities;
43
44        if ($entities->length > 0) {
45            echo "宣言されたエンティティ:\n";
46            foreach ($entities as $entity) {
47                // DOMEntity 型であることを確認します。
48                if ($entity instanceof DOMEntity) {
49                    echo "----------------------------------------\n";
50                    echo "  エンティティ名: " . $entity->nodeName . "\n";
51                    // systemId プロパティにアクセスし、システム識別子を取得します。
52                    // 外部エンティティでない場合や指定されていない場合は null になります。
53                    echo "  システム識別子 (systemId): " . ($entity->systemId ?? 'N/A (内部エンティティまたは未指定)') . "\n";
54                    echo "  公開識別子 (publicId):   " . ($entity->publicId ?? 'N/A') . "\n";
55                    echo "  エンティティ値 (nodeValue): " . ($entity->nodeValue ?? 'N/A (外部エンティティは通常、直接このプロパティで値を持たない)') . "\n";
56                }
57            }
58            echo "----------------------------------------\n";
59        } else {
60            echo "DTD にエンティティが宣言されていません。\n";
61        }
62    } else {
63        echo "XML ドキュメントに DTD が見つかりませんでした。\n";
64    }
65}
66
67// 関数を実行して、DOMEntity::$systemId の動作を確認します。
68demonstrateDomEntitySystemId();
69

DOMEntity::$systemIdは、PHPのDOM拡張機能において、XML DTD（Document Type Definition）で宣言された外部エンティティのシステム識別子を取得するためのプロパティです。このプロパティはDOMEntityクラスに属し、引数は不要です。戻り値は、外部リソースへのURIやパスを示す文字列か、システム識別子が指定されていない場合はnullとなります。

システム識別子とは、XMLドキュメントが外部のデータや定義を参照する際に、その場所（URIやファイルパスなど）を特定するための情報です。例えば、外部のXMLファイルやテキストファイルを参照する場合に利用されます。

なお、キーワードに「systemd」がありましたが、このDOMEntity::$systemIdはLinuxのサービス管理システムである「systemd」とは直接的な関連はありません。XMLドキュメントのコンテキストにおける外部リソースの識別子を指しますので、混同しないようご注意ください。

提供されたサンプルコードでは、具体的なXMLのDOCTYPE内で外部エンティティを宣言し、そのエンティティからsystemIdプロパティを通じて、システム識別子がどのように取得されるかを示しています。これにより、XMLドキュメントが外部リソースをどのように参照しているかを理解することができます。