【PHP8.x】itemメソッドの使い方

Copy
1<?php
2
3// XML 文字列を定義します。
4$xmlString = <<<XML
5<!DOCTYPE test [
6  <!ENTITY ent "entity value">
7  <!NOTATION notation PUBLIC "notation public id" "notation system id">
8]>
9<test></test>
10XML;
11
12// DOMDocument オブジェクトを生成し、XML をロードします。
13$dom = new DOMDocument();
14$dom->loadXML($xmlString);
15
16// DOCTYPE を取得します。
17$doctype = $dom->doctype;
18
19// Entity と Notation の NamedNodeMap を取得します。
20$entities = $doctype->entities;
21$notations = $doctype->notations;
22
23// Entity の NamedNodeMap から指定されたインデックスの Entity を取得します。
24if ($entities instanceof DOMNamedNodeMap) {
25    $entity = $entities->item(0);
26
27    // Entity が存在する場合、名前を表示します。
28    if ($entity instanceof DOMEntity) {
29        echo "Entity Name: " . $entity->nodeName . PHP_EOL; // Output: Entity Name: ent
30    }
31}
32
33// Notation の NamedNodeMap から指定されたインデックスの Notation を取得します。
34if ($notations instanceof DOMNamedNodeMap) {
35    $notation = $notations->item(0);
36
37    // Notation が存在する場合、名前を表示します。
38    if ($notation instanceof DOMNotation) {
39        echo "Notation Name: " . $notation->nodeName . PHP_EOL; // Output: Notation Name: notation
40    }
41}

このサンプルコードは、PHPのDOM拡張を用いて、XMLドキュメントのDOCTYPE宣言に含まれるEntityとNotationを取得し、それらの情報を表示する方法を示しています。

まず、XML文字列を定義し、DOMDocumentオブジェクトにロードします。$dom->doctypeでDOCTYPEノードを取得し、そこからentitiesとnotationsプロパティを使って、それぞれEntityとNotationのDOMNamedNodeMapを取得します。

Dom\DtdNamedNodeMapクラスのitem()メソッドは、引数に指定されたインデックスに対応するEntityまたはNotationノードを返します。引数$indexは整数のインデックス値を指定します。インデックスは0から始まります。もし指定されたインデックスにノードが存在しない場合、nullを返します。

サンプルコードでは、$entities->item(0)で最初のEntityノードを、$notations->item(0)で最初のNotationノードを取得しています。取得したノードがそれぞれDom\EntityまたはDom\Notationのインスタンスであるか確認し、存在する場合はその名前（nodeName）を表示します。この例では、"ent"という名前のEntityと、"notation"という名前のNotationが出力されます。

このコードは、XMLドキュメントの定義（DTD）に含まれるEntityやNotationの情報をプログラムで取得し、処理する際の基本的なパターンを示しています。システムエンジニアを目指す方がXML処理を理解する上で役立つでしょう。

Copy
1<?php
2
3// Dom\DtdNamedNodeMap::item メソッドのサンプルコード
4
5// DTD を含む XML ドキュメントをロード
6$dom = new DOMDocument();
7$dom->loadXML('<!DOCTYPE example [ <!ENTITY ent "Example Entity"> ]><example>&ent;</example>');
8
9// DTD を取得
10$dtd = $dom->doctype;
11
12// DTD が存在する場合
13if ($dtd) {
14    // entities を取得
15    $entities = $dtd->entities;
16
17    // entities が存在する場合
18    if ($entities) {
19        // インデックス 0 の entity を取得
20        $entity = $entities->item(0);
21
22        // entity が存在する場合、名前を出力
23        if ($entity) {
24            echo "Entity Name: " . $entity->nodeName . PHP_EOL; // 出力: Entity Name: ent
25        } else {
26            echo "Entity not found at index 0." . PHP_EOL;
27        }
28    } else {
29        echo "No entities found in DTD." . PHP_EOL;
30    }
31} else {
32    echo "DTD not found." . PHP_EOL;
33}
34
35?>

このサンプルコードは、PHPのDOM拡張におけるDom\DtdNamedNodeMap::itemメソッドの使い方を示しています。Dom\DtdNamedNodeMapは、DTD（Document Type Definition）内で定義されたエンティティや表記のコレクションを表現するオブジェクトです。itemメソッドは、このコレクションから指定されたインデックスに対応するエンティティまたは表記を返します。

サンプルでは、まずDTDを含むXMLドキュメントをDOMDocumentオブジェクトにロードしています。次に、$dom->doctypeでDTDを取得し、そのentitiesプロパティからDom\DtdNamedNodeMapオブジェクトを取得しています。

$entities->item(0)は、Dom\DtdNamedNodeMapオブジェクト内のインデックス0（最初の要素）のエンティティを取得しようと試みます。引数$indexは、取得したい要素のインデックスを指定します。戻り値は、指定されたインデックスに存在するエンティティまたは表記を表すDom\EntityまたはDom\Notationオブジェクトです。もし、指定されたインデックスに要素が存在しない場合は、nullが返されます。

サンプルコードでは、取得したエンティティが存在する場合、その名前（nodeName）を出力します。存在しない場合は、その旨のメッセージを出力します。DTDが存在しない場合や、DTD内にエンティティが存在しない場合も、それぞれ対応するメッセージが出力されます。この例では、DTD内の最初のエンティティ "ent" の名前が出力されることを期待します。