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

documentURIプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

documentURIプロパティはDom\XMLDocumentクラスに属し、現在のXMLドキュメントのURI(Uniform Resource Identifier)を保持するプロパティです。

このプロパティは、XMLドキュメントがどこからロードされたかを示す情報を提供します。例えば、Dom\XMLDocument::load() メソッドでファイルからドキュメントを読み込んだ場合、documentURIプロパティにはそのファイルの絶対パスが文字列として格納され、ドキュメントの元の場所を特定できます。

一方、Dom\XMLDocument::loadXML() メソッドでメモリ上のXML文字列からドキュメントを作成した場合や、プログラムでDOMツリーを構築した場合は、元のファイルパスが存在しないため、このプロパティは通常、空文字列("")または null を保持します。

documentURIプロパティは読み取り専用であり、ドキュメントロード後に直接変更はできません。ドキュメントの出所把握や、関連リソースのパス解決の基準として役立ちます。複数のXMLドキュメントを扱うシステムにおいて、各ドキュメントの識別やデバッグ情報の出力に有用です。XMLドキュメントのメタ情報を理解する上で重要な要素です。

構文(syntax)

1<?php
2
3$document = new Dom\Document();
4$uri = $document->documentURI;
5echo $uri;
6
7?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string|null

XMLドキュメントのURIを表す文字列、またはURIが設定されていない場合はnullを返します。

関連コンテンツ