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

systemIdプロパティは、DOMEntityクラスが扱う外部エンティティのシステム識別子を保持するプロパティです。DOMEntityクラスは、HTMLやXMLドキュメント内で宣言されるエンティティ、特に外部ファイルとして定義されたエンティティを表現するために使用されます。このプロパティは、外部エンティティのコンテンツを特定するためにシステムが利用する情報、例えばURI（Uniform Resource Identifier）やファイルパスなどを文字列として格納します。

具体的には、外部DTD（Document Type Definition）や外部のXMLファイルなどを参照するエンティティ宣言において、そのリソースがどこにあるかを示すシステム依存の識別子を指します。例えば、あるエンティティが"http://example.com/entities/myentity.xml"というURLで定義されている場合、そのURLがsystemIdプロパティの値として保持されます。もしエンティティ宣言にシステム識別子が指定されていない場合は、このプロパティはNULLを保持します。

システムエンジニアを目指す方にとって、XMLドキュメントの外部参照やデータ解決のメカニズムを理解する上で、systemIdプロパティは重要な役割を果たします。このプロパティを参照することで、プログラムが外部リソースをどのように見つけ出し、利用するのかを正確に把握し、適切に処理を実装することができます。

Copy
1<?php
2$dom = new DOMDocument();
3$xml = '<?xml version="1.0"?>
4<!DOCTYPE root [
5  <!ENTITY example SYSTEM "http://example.com/some_dtd.dtd">
6]>
7<root/>';
8$dom->loadXML($xml);
9
10$entities = $dom->doctype->entities;
11$entity = $entities->getNamedItem('example');
12
13if ($entity instanceof DOMEntity) {
14    $systemId = $entity->systemId;
15}

引数なし

引数はありません

string|null

DOMEntityオブジェクトのシステム識別子を表す文字列、またはシステム識別子が存在しない場合はnullを返します。