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

Copy
1<?php
2
3/**
4 * Dom\NamedNodeMap の length プロパティの使用例を示します。
5 * このプロパティは、XML/HTML要素に付与された属性の数を取得するために使用されます。
6 * キーワード「文字列」と混同されがちですが、ここでは「属性の数」を意味します。
7 *
8 * @return void
9 */
10function demonstrateDomNamedNodeMapLengthUsage(): void
11{
12    // DOMDocument オブジェクトを作成します。
13    // XML バージョン 1.0、エンコーディング UTF-8 を指定します。
14    $dom = new DOMDocument('1.0', 'UTF-8');
15    // 出力時に XML を整形（インデントなどを適用）します。
16    $dom->formatOutput = true;
17
18    // ルート要素 <config> を作成し、DOMドキュメントに追加します。
19    $configElement = $dom->createElement('config');
20    $dom->appendChild($configElement);
21
22    // <setting> 要素を作成し、テキストコンテンツを設定します。
23    $settingElement = $dom->createElement('setting', 'データベース接続設定');
24    // <config> 要素の子として <setting> 要素を追加します。
25    $configElement->appendChild($settingElement);
26
27    // <setting> 要素に複数の属性を追加します。
28    $settingElement->setAttribute('id', 'db_connection');
29    $settingElement->setAttribute('host', 'localhost');
30    $settingElement->setAttribute('port', '3306');
31    $settingElement->setAttribute('user', 'admin');
32
33    // <setting> 要素から属性の集合（Dom\NamedNodeMap オブジェクト）を取得します。
34    // Dom\NamedNodeMap は、要素に付与されたすべての属性をマップとして保持します。
35    $attributesMap = $settingElement->attributes;
36
37    echo "--- Dom\\NamedNodeMap::length の使用例 ---\n\n";
38
39    // Dom\NamedNodeMap の length プロパティにアクセスし、属性の数を取得します。
40    // この length は、マップに含まれる属性ノードの総数を整数 (int) で返します。
41    // このプロパティは「文字列の長さ」ではなく、「属性の数」を取得します。
42    $numberOfAttributes = $attributesMap->length;
43
44    echo "要素 '<setting>' には {$numberOfAttributes} 個の属性があります。\n";
45    echo "これは、Dom\\NamedNodeMap が管理する属性ノードの総数を表します。\n\n";
46
47    // 取得された属性の名前と値を一覧表示することもできます（任意）。
48    echo "取得された属性の詳細:\n";
49    foreach ($attributesMap as $attributeNode) {
50        // $attributeNode は DOMAttr のインスタンスです。
51        /* @var DOMAttr $attributeNode */
52        echo "- 名前: {$attributeNode->name}, 値: {$attributeNode->value}\n";
53    }
54}
55
56// 関数を実行して、Dom\NamedNodeMap::length の動作を確認します。
57demonstrateDomNamedNodeMapLengthUsage();

PHPのDom\NamedNodeMap::lengthは、HTMLやXMLドキュメントの要素に付与された属性の数を取得するためのプロパティです。このプロパティは、特定の要素の属性の集合を管理するDom\NamedNodeMapクラスに所属しています。lengthプロパティは引数を一切取らず、そのDom\NamedNodeMapオブジェクトが保持する属性ノードの総数を整数値（int）として返します。これにより、対象の要素が現在いくつの属性を持っているかを簡単に確認できます。

特に注意が必要なのは、PHPの他のコンテキストで見られる「文字列の長さ」を意味するlength表現と異なり、Dom\NamedNodeMap::lengthではHTMLやXML要素の「属性の総数」を指す点です。サンプルコードでは、まずDOMDocumentを作成し、config要素の中にsetting要素を配置しています。このsetting要素に対して、id、host、port、userといった複数の属性がsetAttributeメソッドを使って追加されます。

その後、$settingElement->attributesを通じてDom\NamedNodeMapオブジェクトを取得し、このオブジェクトのlengthプロパティにアクセスすることで、setting要素に付与された属性の総数が取得されます。実行すると、「要素 '<setting>' には4個の属性があります。」と出力され、このプロパティが要素の属性数を効率的に数える役割を果たすことが明確に示されます。これにより、HTML/XMLドキュメントの解析や操作において、要素の属性の状態を正確に把握するのに役立ちます。