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

Copy
1<?php
2
3/**
4 * Dom\Entity::systemId プロパティの使用例を示す関数です。
5 * このプロパティは、XMLのDTD（Document Type Definition）で定義された
6 * 外部エンティティのシステム識別子（通常はURIやパス）を返します。
7 *
8 * このシステムIDは、OSのコマンド実行（例: system('id')）とは概念的に異なります。
9 */
10function demonstrateDomEntitySystemId(): void
11{
12    // DTD（Document Type Definition）を含むXML文字列を定義します。
13    // ここでは、'exampleEntity' という名前の外部エンティティを定義し、
14    // そのシステム識別子として 'http://example.com/external.dtd' を指定しています。
15    $xmlString = <<<XML
16<!DOCTYPE root [
17  <!ENTITY exampleEntity SYSTEM "http://example.com/external.dtd">
18]>
19<root>
20  <element></element>
21</root>
22XML;
23
24    // DOMDocument オブジェクトを生成し、XML文字列をロードします。
25    $dom = new DOMDocument();
26    $dom->loadXML($xmlString);
27
28    // XMLドキュメントから DOCTYPE ノード（DTD情報）を取得します。
29    $doctype = $dom->doctype;
30
31    // DOCTYPEが存在し、それがDOMDTDインスタンスであることを確認します。
32    if ($doctype instanceof DOMDTD) {
33        // DTDに定義されているエンティティのリストを取得します。
34        $entities = $doctype->entities;
35
36        // エンティティが1つ以上存在する場合
37        if ($entities->length > 0) {
38            // リストの最初のエンティティを取得します。
39            // これは Dom\Entity クラスのインスタンスです。
40            $entity = $entities->item(0);
41
42            // 取得したオブジェクトが Dom\Entity インスタンスであることを確認します。
43            if ($entity instanceof Dom\Entity) {
44                // Dom\Entity::systemId プロパティにアクセスし、その値を出力します。
45                echo "エンティティ名: " . $entity->nodeName . PHP_EOL;
46                echo "取得されたシステムID (Dom\\Entity::systemId): " . $entity->systemId . PHP_EOL;
47            } else {
48                echo "DTD内の最初のエンティティは Dom\\Entity インスタンスではありません。" . PHP_EOL;
49            }
50        } else {
51            echo "このXMLのDTDにはエンティティが定義されていません。" . PHP_EOL;
52        }
53    } else {
54        echo "このXMLドキュメントにはDTDがありません。" . PHP_EOL;
55    }
56}
57
58// 定義した関数を実行して、Dom\Entity::systemId の使用例を示します。
59demonstrateDomEntitySystemId();

PHPのDom\Entity::systemIdプロパティは、XMLドキュメントのDTD（Document Type Definition）内で定義された外部エンティティのシステム識別子を取得するために使用されます。このプロパティは引数を持たず、外部リソースのURI（Uniform Resource Identifier）やファイルパスを示す文字列（string）を返します。システム識別子とは、外部エンティティの実体がどこにあるかを示すものです。

このsystemIdは、PHPでOSコマンドを実行するsystem('id')のような関数とは全く異なる概念であることを理解してください。Dom\Entity::systemIdはXMLドキュメントの構造や定義に関連する情報であり、OSのユーザーIDなどを取得するものではありません。

サンプルコードでは、まず外部エンティティ定義を含むXML文字列を準備し、DOMDocumentオブジェクトに読み込ませています。その後、ドキュメントからDTD情報を表すDOMDTDオブジェクトを取得し、その中のエンティティリストから最初のDom\Entityインスタンスを取り出しています。このDom\EntityインスタンスのsystemIdプロパティにアクセスすることで、XML内で指定された外部エンティティのシステム識別子である「http://example.com/external.dtd」という文字列が取得され、画面に出力されます。このように、XMLのDTD情報を解析し、外部リソースの場所を特定する際にこのプロパティが役立ちます。

Copy
1<?php
2
3/**
4 * Demonstrates how to retrieve the system ID of a Dom\Entity.
5 *
6 * This example uses an XML document with an internal DTD that defines an entity.
7 * The 'systemId' of this entity is set to a path resembling a systemd unit file
8 * to align with the "systemd" keyword, showing how such an identifier would be
9 * stored and retrieved, although Dom\Entity's primary purpose is XML entity resolution.
10 */
11function getDomEntitySystemIdForSystemdExample(): ?string
12{
13    // XML string with an internal DTD declaring an entity.
14    // The systemId points to a hypothetical systemd service configuration file.
15    $xmlString = <<<XML
16<!DOCTYPE document [
17  <!ENTITY systemd_config_path SYSTEM "file:///etc/systemd/system/my_service.service">
18]>
19<document>
20  <description>
21    This document references a systemd service configuration using an XML entity.
22    The entity 'systemd_config_path' has a system identifier that points to a specific file.
23  </description>
24  <reference>&systemd_config_path;</reference>
25</document>
26XML;
27
28    $dom = new Dom\Document();
29
30    // Load the XML string.
31    // LIBXML_DTDLOAD is important to parse the DTD and populate the entities map.
32    // LIBXML_NOERROR and LIBXML_NOWARNING suppress potential parser warnings/errors.
33    @$dom->loadXML($xmlString, LIBXML_DTDLOAD | LIBXML_NOERROR | LIBXML_NOWARNING);
34
35    // Check if the document has a DOCTYPE declaration.
36    if ($dom->doctype instanceof Dom\DocumentType) {
37        $entities = $dom->doctype->entities;
38
39        // Iterate through all declared entities.
40        foreach ($entities as $entity) {
41            // Ensure the current node is a Dom\Entity (which it should be if it's from ->entities).
42            if ($entity instanceof Dom\Entity) {
43                // We are looking for the entity named 'systemd_config_path'.
44                if ($entity->nodeName === 'systemd_config_path') {
45                    // The 'systemId' property holds the system identifier (URI) of the entity.
46                    return $entity->systemId;
47                }
48            }
49        }
50    }
51
52    return null; // Return null if the entity or DOCTYPE is not found.
53}
54
55// Execute the function and display the result.
56$systemIdValue = getDomEntitySystemIdForSystemdExample();
57
58if ($systemIdValue !== null) {
59    echo "The system ID for 'systemd_config_path' entity is: " . $systemIdValue . PHP_EOL;
60} else {
61    echo "Could not find the 'systemd_config_path' entity or DOCTYPE in the XML." . PHP_EOL;
62}
63

このコードは、PHPのDOM拡張機能を使用し、XML文書のDTD（Document Type Definition）で定義されたエンティティのsystemIdプロパティを取得する方法を示しています。Dom\EntityクラスのsystemIdプロパティは、外部エンティティのシステム識別子、つまりURI（Uniform Resource Identifier）を文字列として返します。このプロパティは引数を取りません。

サンプルコードでは、内部DTDを持つXML文字列を作成し、systemd_config_pathという名前のエンティティを定義しています。このエンティティのsystemIdには、file:///etc/systemd/system/my_service.serviceという、systemdの設定ファイルを模したパスが設定されています。Dom\DocumentクラスでXMLを読み込む際に、LIBXML_DTDLOADオプションを指定することでDTDがパースされ、エンティティ情報がロードされます。

その後、Dom\Documentのdoctypeプロパティからentitiesマップにアクセスし、定義されたエンティティ群を探索します。systemd_config_pathエンティティを見つけると、そのsystemIdプロパティから設定されたパスを文字列として取得し、結果を表示しています。これにより、XMLエンティティが外部リソースをどのように参照しているかを確認できます。