【PHP8.x】DOMProcessingInstruction::baseURIプロパティの使い方

Copy
1<?php
2
3/**
4 * DOMProcessingInstruction クラスの baseURI プロパティの利用例
5 *
6 * この関数は、XML ドキュメント内に処理命令 (Processing Instruction) を作成し、
7 * その処理命令の基底 URI (baseURI) を取得して表示します。
8 * baseURI は、XML ノードが定義されている場所の URI を示します。
9 *
10 * インメモリで新規作成された DOM ドキュメントの場合、通常 baseURI は
11 * null または空文字列になります。外部ファイルからドキュメントを読み込んだ場合、
12 * そのファイルの URI が baseURI として返されることがあります。
13 */
14function demonstrateDomProcessingInstructionBaseURI(): void
15{
16    // 1. DOM ドキュメントオブジェクトを新規作成
17    $dom = new DOMDocument('1.0', 'UTF-8');
18    $dom->formatOutput = true; // 出力を整形する設定 (必須ではないが、可読性向上)
19
20    // 2. XML 処理命令 (Processing Instruction) を作成
21    // 例: <?php echo "Hello"; ?> のような形式を想定
22    // 第一引数はターゲット (例: "php", "xml-stylesheet")
23    // 第二引数は処理命令のデータ (例: "echo \"Hello\";", "type=\"text/css\" href=\"style.css\"")
24    $processingInstruction = $dom->createProcessingInstruction(
25        'php',
26        'echo "PHP Processing Instruction Demo";'
27    );
28
29    // 3. 作成した処理命令をドキュメントに追加
30    // 処理命令は通常、ドキュメントのルート要素の前または後に配置されます
31    $dom->appendChild($processingInstruction);
32
33    // 4. DOMProcessingInstruction オブジェクトの baseURI プロパティにアクセス
34    // baseURI は string または null を返します
35    $baseURI = $processingInstruction->baseURI;
36
37    // 5. 取得した baseURI の値を出力
38    echo "作成した処理命令の XML (確認用): " . PHP_EOL;
39    echo $dom->saveXML() . PHP_EOL; // ドキュメント全体のXMLを出力
40
41    echo "DOMProcessingInstruction::baseURI の値: ";
42    if ($baseURI !== null && $baseURI !== '') {
43        echo "'" . $baseURI . "'" . PHP_EOL;
44    } else {
45        // インメモリで作成したドキュメントの場合、通常は null または空文字列
46        echo "未設定または空です (通常、インメモリで新規作成されたノードの場合)。" . PHP_EOL;
47    }
48
49    // 補足: もしXMLをファイルからロードした場合
50    // $dom->load('example.xml');
51    // その example.xml ファイル内の処理命令の baseURI は、example.xml のパスを返す可能性があります。
52}
53
54// 関数の実行
55demonstrateDomProcessingInstructionBaseURI();
56
57?>

DOMProcessingInstruction::baseURIプロパティは、PHPのDOM拡張機能において、XMLドキュメント内の「処理命令（Processing Instruction）」が定義されている場所の基底URI（ベースURI）を取得するために使用されます。処理命令とは、XMLパーサーに対して特定の処理を指示する特別な命令のことで、例えば<?php echo "Hello"; ?>のような形式です。このプロパティは引数を必要とせず、基底URIを文字列（string）として返すか、または情報がない場合はnullを返します。

サンプルコードでは、まず新しいDOMDocumentオブジェクトを作成し、その中にcreateProcessingInstructionメソッドを使って新しい処理命令を生成しています。生成された処理命令はドキュメントに追加され、その後$processingInstruction->baseURIとしてこのプロパティにアクセスしています。

プログラム内で新しく作成されたDOMDocumentとその中のノードの場合、通常、baseURIプロパティの値はnullまたは空文字列になります。これは、そのノードが特定のファイルパスに紐付いていないためです。しかし、もしXMLドキュメントを外部ファイルから読み込んだ場合、その読み込まれたファイルのURI（パス）がbaseURIとして返される可能性があります。このプロパティは、XMLノードがどこから来たのか、その元の場所を特定する際に役立ちます。

Copy
1<?php
2
3/**
4 * DOMProcessingInstruction::baseURI プロパティの取得例。
5 *
6 * この関数は、XML文字列をDOMDocumentにロードし、
7 * その中に含まれる DOMProcessingInstruction ノードの baseURI プロパティを取得します。
8 *
9 * baseURI は、そのノードが所属するドキュメントのベースURIを示します。
10 * DOMDocument::loadXML() を使用して文字列からロードした場合、通常 baseURI は null になります。
11 * （DOMDocument::load() を使用してファイルからロードした場合は、そのファイルのパスが設定されることがあります。）
12 *
13 * @return string|null 処理命令ノードの baseURI、または処理命令が見つからない場合は null
14 */
15function getProcessingInstructionBaseURIExample(): ?string
16{
17    // XMLコンテンツを定義し、処理命令を含める
18    // <?php ... ?> の部分が DOMProcessingInstruction ノードとして扱われます。
19    $xmlContent = <<<'XML'
20<?xml version="1.0" encoding="UTF-8"?>
21<?php echo "Hello from a PHP processing instruction within XML"; ?>
22<root>
23    <item>Example Item</item>
24</root>
25XML;
26
27    // DOMDocument オブジェクトを作成
28    $dom = new DOMDocument();
29
30    // XMLコンテンツをロード
31    // ロードに失敗した場合はエラーメッセージを表示し、nullを返す
32    if (!$dom->loadXML($xmlContent)) {
33        echo "Error: XMLコンテンツのロードに失敗しました。" . PHP_EOL;
34        return null;
35    }
36
37    // ドキュメント内のすべての子ノードを走査し、DOMProcessingInstruction ノードを探す
38    foreach ($dom->childNodes as $node) {
39        if ($node instanceof DOMProcessingInstruction) {
40            // DOMProcessingInstruction ノードが見つかったら、その baseURI プロパティを返す
41            return $node->baseURI;
42        }
43    }
44
45    // ドキュメント内に処理命令ノードが見つからなかった場合
46    return null;
47}
48
49// 関数の実行と結果の表示
50$baseUri = getProcessingInstructionBaseURIExample();
51
52if ($baseUri === null) {
53    echo "DOMProcessingInstruction の baseURI は null です。" . PHP_EOL;
54    echo "（DOMDocument::loadXML() を使用して文字列からロードした場合は、通常 null になります。）" . PHP_EOL;
55} else {
56    echo "DOMProcessingInstruction の baseURI: '{$baseUri}'" . PHP_EOL;
57}
58
59?>

DOMProcessingInstruction::baseURI プロパティは、XMLドキュメント内の処理命令（Processing Instruction）ノードが属するドキュメントのベースURI（Uniform Resource Identifier）を取得するために使用されます。このプロパティに引数はなく、戻り値はベースURIを示す string 型、またはベースURIが存在しない場合は null となります。

このサンプルコードでは、まずPHPの処理命令を含むXMLコンテンツを変数に定義します。次に、DOMDocument オブジェクトを作成し、loadXML() メソッドを使用してこのXMLコンテンツをオブジェクトにロードします。このメソッドは、XML文字列からドキュメントを構築する際に利用されます。

ドキュメントがロードされた後、コードはドキュメント内のすべての子ノードを順に走査し、DOMProcessingInstruction クラスのインスタンスであるノードを探します。処理命令ノードが見つかると、その baseURI プロパティにアクセスして値を取得し、その値を返します。

DOMDocument::loadXML() を使用してXML文字列からドキュメントをロードした場合、ノードにはファイルパスのような具体的なURI情報がないため、baseURI プロパティは通常 null を返します。これに対し、DOMDocument::load() メソッドでファイルを直接ロードした場合は、そのファイルのパスが baseURI として設定されることがあります。

サンプルコードの実行結果では、DOMProcessingInstruction の baseURI が null であることが示され、loadXML() 使用時の挙動が確認できます。