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

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

作成日: 更新日:

基本的な使い方

documentURIプロパティは、DOMDocumentオブジェクトが扱うドキュメントのURI(Uniform Resource Identifier)を保持するプロパティです。

このプロパティを使用すると、XMLやHTMLなどのドキュメントがどこから読み込まれたのか、その元の場所を示すURI情報を取得できます。具体的には、DOMDocumentオブジェクトがload()loadHTMLFile()などのメソッドを用いて外部リソースからドキュメントを読み込んだ際に、そのリソースのURIが自動的に設定されます。例えば、ファイルシステム上のXMLファイルを読み込んだ場合はそのファイルのパスが、ウェブサイトのHTMLを読み込んだ場合はそのURLが格納されます。

ドキュメントがまだ読み込まれていない場合や、ドキュメントのソースURIが不明な場合はnullを返します。このdocumentURIプロパティは読み取り専用であり、プログラムから直接その値を変更することはできません。

ドキュメントの出所を確認したい場合や、ドキュメント内の相対パスを解決するための基準として利用できます。これにより、セキュリティチェックや関連リソースの正確な参照に役立ち、DOM操作におけるドキュメントのコンテキストを把握するために重要な情報を提供します。

構文(syntax)

1<?php
2$dom = new DOMDocument();
3$uri = $dom->documentURI;
4?>

引数(parameters)

戻り値(return)

?string

DOMDocumentオブジェクトで読み込まれたドキュメントのURI(Uniform Resource Identifier)を表す文字列です。ドキュメントがURIを持たない場合はnullが返されます。

関連コンテンツ