【PHP8.x】DOMEntity::hasAttributes()メソッドの使い方

Copy
1<?php
2
3/**
4 * DOMEntity::hasAttributes の使用例を示します。
5 *
6 * この関数は、DTD(文書型定義)内に定義されたエンティティノードを取得し、
7 * そのノードが属性を持っているかどうかを hasAttributes() メソッドで確認します。
8 */
9function checkEntityAttributes(): void
10{
11    // DTDでエンティティを定義したXML文字列を用意します。
12    // <!ENTITY writer ...> がエンティティ宣言に相当します。
13    $xmlString = <<<XML
14<?xml version="1.0" encoding="UTF-8"?>
15<!DOCTYPE note [
16  <!ENTITY writer "Taro Yamada">
17  <!ENTITY company "Example Inc.">
18]>
19<note>
20  <from>&writer;</from>
21  <corp>&company;</corp>
22</note>
23XML;
24
25    // DOMDocumentオブジェクトを生成し、XMLを読み込みます。
26    $document = new DOMDocument();
27    $document->loadXML($xmlString);
28
29    // Doctypeノードを取得し、その中のエンティティ定義のリストを取得します。
30    $entities = $document->doctype->entities;
31
32    // 'writer' という名前のエンティティノード (DOMEntityオブジェクト) を取得します。
33    $entity = $entities->getNamedItem('writer');
34
35    // ノードがDOMEntityのインスタンスであることを確認します。
36    if ($entity instanceof DOMEntity) {
37        echo "エンティティ '{$entity->nodeName}' は属性を持っていますか？" . PHP_EOL;
38
39        // DOMEntity::hasAttributes() を呼び出します。
40        // エンティティ宣言ノード自体は属性を持つことができないため、このメソッドは常に false を返します。
41        $result = $entity->hasAttributes();
42
43        // 結果を bool 値として出力します。
44        var_dump($result); // 出力: bool(false)
45    } else {
46        echo "エンティティ 'writer' が見つかりませんでした。" . PHP_EOL;
47    }
48}
49
50// 関数を実行して結果を確認します。
51checkEntityAttributes();

PHPの DOMEntity::hasAttributes メソッドは、XMLの文書型定義（DTD）内で宣言されたエンティティノードが、属性を持っているかどうかを判定するためのものです。このメソッドは引数を必要としません。

サンプルコードでは、まずDTDを含むXML文字列を読み込み、DOMDocumentオブジェクトを生成します。次に、<!ENTITY writer ...> という宣言で定義された writer という名前のエンティティノードを取得します。そして、取得したエンティティノード（DOMEntityオブジェクト）に対して hasAttributes() メソッドを呼び出しています。

このメソッドの戻り値は、属性が存在すれば true、存在しなければ false となる真偽値（bool）です。しかし、XMLの仕様上、エンティティ宣言そのもの（例: <!ENTITY ...>）は属性を持つことができません。そのため、DOMEntity オブジェクトに対してこのメソッドを呼び出した場合、結果は常に false となります。サンプルコードの var_dump($result); が bool(false) と出力するのはこのためです。