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

Copy
1<?php
2
3/**
4 * Demonstrates the usage of SimpleXMLElement::key() method.
5 *
6 * This function illustrates how to retrieve the tag name (key)
7 * of SimpleXMLElement objects when iterating through XML elements.
8 * SimpleXMLElement::key() returns the XML tag name of the current element
9 * as a string. It is useful for identifying the type of an element
10 * within a loop, similar to getting a key in a key-value pair.
11 */
12function demonstrateSimpleXMLElementKey(): void
13{
14    // Define a simple XML string for demonstration purposes.
15    // This XML represents a list of products with their details.
16    $xmlString = <<<XML
17<products>
18    <product id="P001">
19        <name>Laptop</name>
20        <price>1200.00</price>
21        <features>
22            <feature>16GB RAM</feature>
23            <feature>512GB SSD</feature>
24        </features>
25    </product>
26    <product id="P002">
27        <name>Mouse</name>
28        <price>25.00</price>
29    </product>
30    <category>Electronics</category>
31</products>
32XML;
33
34    // Create a SimpleXMLElement object from the XML string.
35    // This object allows easy access to XML elements and their attributes.
36    $productsXml = new SimpleXMLElement($xmlString);
37
38    echo "--- Iterating over direct children of <products> ---" . PHP_EOL;
39    // Iterate over the immediate child elements of the <products> root.
40    // Each $childElement in this loop is a SimpleXMLElement object representing a child tag.
41    foreach ($productsXml->children() as $childElement) {
42        // SimpleXMLElement::key() is called on the current child element.
43        // It returns the tag name of that element (e.g., 'product', 'category') as a string.
44        $tag_name = $childElement->key();
45
46        // (string)$childElement casts the SimpleXMLElement object to a string,
47        // which retrieves its text content if it has no further child elements.
48        $element_value = (string)$childElement;
49
50        echo "Element Tag (Key): '{$tag_name}'";
51        if (!empty($element_value)) {
52            echo ", Value: '{$element_value}'";
53        }
54        echo PHP_EOL;
55
56        // If the child element is a 'product', we can further iterate over its children
57        // to show nested key-value pairs.
58        if ($childElement->getName() === 'product') {
59            echo "  --- Children of '{$tag_name}' (ID: {$childElement['id']}) ---" . PHP_EOL;
60            foreach ($childElement->children() as $grandChildElement) {
61                $grand_child_tag_name = $grandChildElement->key();
62                $grand_child_value = (string)$grandChildElement;
63
64                echo "    Child Tag (Key): '{$grand_child_tag_name}'";
65                if (!empty($grand_child_value)) {
66                    echo ", Value: '{$grand_child_value}'";
67                }
68                echo PHP_EOL;
69            }
70        }
71    }
72
73    echo PHP_EOL;
74
75    // Demonstrate calling key() on a specific, directly accessed element.
76    echo "--- Demonstrating key() on a specific element ---" . PHP_EOL;
77    // Access the 'name' element of the first 'product'.
78    $firstProductNameElement = $productsXml->product[0]->name;
79
80    // Call key() on this specific 'name' element.
81    echo "Key of the first product's 'name' element: '" . $firstProductNameElement->key() . "'";
82    echo ", Value: '" . (string)$firstProductNameElement . "'" . PHP_EOL;
83}
84
85// Call the function to execute the demonstration.
86demonstrateSimpleXMLElementKey();
87
88?>

SimpleXMLElement::key()メソッドは、PHPでXMLデータを扱うためのSimpleXMLElementクラスに属するメソッドです。このメソッドは、XML文書内の特定の要素が持つ「タグ名」、つまり要素名を文字列として取得するのに利用されます。

引数は不要で、現在のSimpleXMLElementオブジェクトが指しているXML要素のタグ名を文字列（string）で返します。例えば、<name>というXML要素に対してこのメソッドを呼び出すと、'name'という文字列が戻り値となります。非常に稀なケースや特定の内部処理においては、整数（int）やnullが返されることもありますが、通常の用途ではタグ名を示す文字列が返されます。

サンプルコードでは、定義されたXMLデータからSimpleXMLElementオブジェクトを作成し、products要素の直下にある子要素を一つずつ処理しています。ループ内で各子要素に対してkey()メソッドを呼び出すことで、それが<product>要素なのか、それとも<category>要素なのかといったタグ名を正確に取得しています。このように、XML要素のタグ名に基づいて処理を分岐させたり、構造を把握したりする際にkey()メソッドは非常に有用です。これにより、XML要素が持つ名前がデータ構造における「キー」のような役割を果たし、プログラムがXMLデータを効率的に操作できるようになります。

Copy
1<?php
2
3/**
4 * SimpleXMLElement::key() メソッドの使用例を示します。
5 *
6 * このメソッドは、SimpleXMLElement オブジェクトがイテレータとして使用されている際に、
7 * 現在位置のキーを返します。戻り値は string|int|null のいずれかです。
8 *
9 * - もし現在の要素と同じタグ名を持つ兄弟要素が存在する場合、
10 *   それらの要素群の中での現在の要素の数値インデックス（0, 1, 2...）を int で返します。
11 * - もし現在の要素と同じタグ名を持つ兄弟要素が存在しない場合（つまり、そのタグ名を持つ唯一の要素である場合）、
12 *   その要素のタグ名（string）を返します。
13 * - イテレーションのコンテキスト外で呼び出された場合や、キーが存在しない場合は null を返します。
14 *
15 * システムエンジニアを目指す初心者の方にも理解しやすいよう、
16 * XMLの構造とそれに対応するキーの関係を具体的に示します。
17 */
18function demonstrateSimpleXMLElementKey(): void
19{
20    // サンプルXML文字列を定義
21    // <data>要素の直下の子要素をイテレートします。
22    $xmlString = <<<XML
23<data>
24    <item id="A">First Item</item>
25    <item id="B">Second Item</item>
26    <section>Important Section</section>
27    <item id="C">Third Item</item>
28    <section>Another Section</section>
29    <entry>Single Entry</entry>
30</data>
31XML;
32
33    // XML文字列から SimpleXMLElement オブジェクトを作成
34    $xml = new SimpleXMLElement($xmlString);
35
36    echo "--- SimpleXMLElement::key() メソッドの使用例 ---\n";
37    echo "XML構造をイテレートし、各子要素のキーを取得します。\n\n";
38
39    // SimpleXMLElement は Iterator インターフェースを実装しているため、
40    // rewind(), current(), key(), next(), valid() メソッドを使って明示的にイテレートできます。
41    // まずイテレータを最初の要素にリセットします。
42    $xml->rewind();
43
44    // イテレーションが有効な間、ループを続けます
45    // 無限ループを防ぐため、安全のためにカウンターを追加
46    $iterationCount = 0;
47    $maxIterations = 10; // 想定される要素数に応じて適切な最大値を設定
48
49    while ($xml->valid() && $iterationCount < $maxIterations) {
50        // 現在の要素のキーを取得します。
51        // 戻り値は string|int|null です。
52        $currentKey = $xml->key();
53
54        // 現在の要素オブジェクトを取得します。
55        $currentElement = $xml->current();
56
57        echo "要素名: " . $currentElement->getName();
58        // SimpleXMLElement を文字列として出力するにはキャストが必要です。
59        echo ", 値: '" . (string)$currentElement . "'\n";
60        echo "  取得したキー (\$xml->key()): ";
61        
62        // キーの型（int または string）を明確に示すため var_dump を使用
63        var_dump($currentKey);
64        echo "\n";
65
66        // 次の要素に進みます。
67        $xml->next();
68        $iterationCount++;
69    }
70
71    echo "--- イテレーション終了 ---\n";
72
73    // 補足: イテレーションコンテキスト外で親要素に対して key() を直接呼び出すと、
74    // 通常は null が返されます。key() メソッドはイテレーション中にその「現在の位置」のキーを返します。
75    echo "\n補足: イテレーションコンテキスト外での親要素に対する SimpleXMLElement::key() の呼び出しは通常 null を返します。\n";
76    echo "親要素 (\$xml) のキー: ";
77    var_dump($xml->key()); // イテレーション外なので null になる
78}
79
80// 関数を実行
81demonstrateSimpleXMLElementKey();

SimpleXMLElement::key() メソッドは、XML要素を扱う SimpleXMLElement オブジェクトがイテレータとして使用されている際に、現在位置の「キー」を取得するために利用されます。このメソッドは引数を取りません。

戻り値は string、int、または null のいずれかとなります。もし、現在の要素と同じタグ名を持つ兄弟要素が他に存在する場合、それらの要素群の中での現在の要素の数値インデックス（0から始まる整数）が int で返されます。一方、同じタグ名を持つ兄弟要素が存在せず、そのタグ名を持つ唯一の要素である場合は、その要素のタグ名が string で返されます。イテレーションのコンテキスト外で呼び出された場合や、キーが存在しない場合には null が返されます。

サンプルコードでは、data要素の子要素を while ループで順にイテレートしています。$xml->rewind() でイテレータを初期位置に戻し、$xml->valid() で有効な要素がある間、$xml->next() で次の要素へ進みながら処理を行います。ループ内で $xml->key() を呼び出すことで、各子要素のキーを取得しています。例えば、<item>要素は複数存在するため、0, 1, 2といった整数がキーとして返されますが、<section>や<entry>のように同じタグ名の子要素が単独である場合は、そのタグ名自身がキーとして返されることを確認できます。また、イテレーションループの外で key() メソッドを呼び出すと、通常は null が返される挙動も示しています。