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

Copy
1<?php
2
3/**
4 * SimpleXMLElement::children() メソッドの基本的な使用例を示します。
5 * このメソッドは、XML要素の直下の子要素をSimpleXMLElementオブジェクトのコレクションとして取得するために使用されます。
6 * キーワード「children's」に関連付けて、子供向け商品リストのXMLから子要素を抽出する例です。
7 */
8function demonstrateSimpleXMLElementChildren(): void
9{
10    // 子供向け商品を含む架空のショップXMLデータを作成します。
11    // これには「Children's Products」カテゴリと「Adult Products」カテゴリが含まれています。
12    $xmlString = <<<XML
13<?xml version="1.0" encoding="UTF-8"?>
14<shop>
15    <category name="Children's Products">
16        <item id="C001">
17            <name>Toy Car</name>
18            <price>15.99</price>
19        </item>
20        <item id="C002">
21            <name>Story Book</name>
22            <price>9.50</price>
23        </item>
24    </category>
25    <category name="Adult Products">
26        <item id="A001">
27            <name>Coffee Mug</name>
28            <price>12.00</price>
29        </item>
30    </category>
31</shop>
32XML;
33
34    // XML文字列をSimpleXMLElementオブジェクトにパースします。
35    // これにより、XMLデータをオブジェクトのプロパティやメソッドとして簡単に操作できるようになります。
36    $xml = new SimpleXMLElement($xmlString);
37
38    echo "--- ショップの全カテゴリ（直下の子要素）を取得して表示 ---\n";
39
40    // $xml->children() メソッドは、現在の要素（ここでは<shop>要素）の直下にある
41    // 全ての子要素（<category>要素）をSimpleXMLElementオブジェクトの配列として返します。
42    // 引数を指定しない場合、デフォルトの名前空間の子要素が取得されます。
43    $categories = $xml->children();
44
45    // 取得した各カテゴリをループ処理します。
46    foreach ($categories as $category) {
47        // SimpleXMLElementオブジェクトは、要素の属性を配列のようにアクセスできます。
48        // (string)にキャストすることで、SimpleXMLElementオブジェクトから文字列値を取得します。
49        echo "カテゴリ名: " . (string)$category['name'] . "\n";
50
51        // 各カテゴリ要素の直下にある全ての子要素（ここでは<item>要素）を取得します。
52        // $category->children() を使うことで、現在のカテゴリに属する商品にアクセスします。
53        $items = $category->children();
54
55        // 取得した各商品をループ処理します。
56        foreach ($items as $item) {
57            // 商品のID属性と、<name>および<price>子要素のテキスト値を取得して表示します。
58            // 子要素はオブジェクトのプロパティとして直接アクセスできます。
59            echo "  - 商品ID: " . (string)$item['id'] . ", 名前: " . (string)$item->name . ", 価格: " . (string)$item->price . "\n";
60        }
61        echo "\n"; // 各カテゴリの出力後に改行を追加し、見やすくします
62    }
63
64    echo "--- 「Children's Products」カテゴリのみを抽出して商品情報を表示 ---\n";
65
66    // 特定の条件に基づいて要素をフィルターし、その子要素を取得する応用例です。
67    // SimpleXMLElementオブジェクトは、子要素の名前（例: $xml->category）を使って直接アクセスすることもできます。
68    // この場合、$xml->category は、shop直下の全てのcategory要素のコレクションを返します。
69    foreach ($xml->category as $category) {
70        // カテゴリの'name'属性が"Children's Products"であるかチェックします。
71        // 属性値は常に(string)にキャストして比較するのが安全です。
72        if ((string)$category['name'] === "Children's Products") {
73            echo "[対象カテゴリ] " . (string)$category['name'] . "\n";
74            // この特定のカテゴリの子要素（商品）を再度children()メソッドで取得します。
75            foreach ($category->children() as $childItem) {
76                echo "  - 商品ID: " . (string)$childItem['id'] . ", 名前: " . (string)$childItem->name . ", 価格: " . (string)$childItem->price . "\n";
77            }
78        }
79    }
80}
81
82// 定義した関数を実行します。
83demonstrateSimpleXMLElementChildren();

SimpleXMLElement::children()メソッドは、PHPでXMLデータをオブジェクトとして扱うSimpleXMLElementクラスに属し、現在のXML要素の直下にある全ての子要素を取得するために使用されます。

引数$namespaceOrPrefixに名前空間URIまたはプレフィックスを指定することで、特定の名前空間に属する子要素のみを抽出できます。通常はNULLを指定し、名前空間を持たないかデフォルトの名前空間の子要素を取得します。$isPrefixをtrueに設定すると、$namespaceOrPrefixが名前空間URIではなくプレフィックスとして解釈されます。このメソッドの戻り値は、取得された全ての子要素を格納するSimpleXMLElementオブジェクトのコレクションです。

サンプルコードでは、架空のショップXMLデータから商品情報を抽出する例を通じて、このメソッドの基本的な使い方を示しています。まず、ショップ全体のXMLをパースした後、$xml->children()を実行することで、<shop>要素の直下にある<category>要素群をまとめて取得しています。次に、各カテゴリ内では$category->children()を使って、そのカテゴリに属する<item>要素群を抽出しています。これにより、XMLの階層構造を簡単に辿り、各要素の属性値（例：商品のID）や子要素のテキスト値（例：商品名、価格）に効率的にアクセスできます。このメソッドは、XMLデータから必要な情報を整理して取り出す際に非常に重要な役割を果たします。

Copy
1<?php
2
3/**
4 * 病院のXMLデータから部門や患者情報を取得するサンプルコードです。
5 * SimpleXMLElement::children() メソッドの使用例を示します。
6 *
7 * この関数は、XML形式で定義された病院の構造を解析し、
8 * 各部門とその患者情報、およびスタッフ情報を表示します。
9 * キーワード「children's hospital」を考慮し、小児科（Pediatrics）の情報を具体的に含んでいます。
10 */
11function getHospitalInformation(): void
12{
13    // 病院の情報をXML形式で定義します。
14    // 小児科（Pediatrics）の部門と患者、そして小児科医を含めています。
15    $xmlString = <<<XML
16<?xml version="1.0" encoding="UTF-8"?>
17<hospital>
18    <departments>
19        <department name="Pediatrics">
20            <patient id="CH001">
21                <name>Alice Smith</name>
22                <age>7</age>
23            </patient>
24            <patient id="CH002">
25                <name>Bob Johnson</name>
26                <age>10</age>
27            </patient>
28        </department>
29        <department name="Cardiology">
30            <patient id="AD001">
31                <name>Carol White</name>
32                <age>55</age>
33            </patient>
34        </department>
35    </departments>
36    <staff>
37        <doctor specialization="Pediatrics">Dr. Emily Green</doctor>
38        <doctor specialization="General">Dr. Robert Brown</doctor>
39    </staff>
40</hospital>
41XML;
42
43    try {
44        // XML文字列をSimpleXMLElementオブジェクトに読み込みます。
45        $hospitalXml = new SimpleXMLElement($xmlString);
46
47        echo "--- 病院のトップレベルの子要素 ---" . PHP_EOL;
48        // children() メソッドは、現在の要素のすべての子要素をSimpleXMLElementオブジェクトの配列として返します。
49        // 引数なしの場合、XMLの名前空間に関わらず全ての子要素が対象です。
50        foreach ($hospitalXml->children() as $child) {
51            echo "トップレベル要素名: " . $child->getName() . PHP_EOL;
52        }
53        echo PHP_EOL;
54
55        echo "--- 各部門の患者情報 ---" . PHP_EOL;
56        // 'departments'要素の子要素（各'department'要素）をループで処理します。
57        // $hospitalXml->departments で <departments> 要素にアクセスし、
58        // その後 children() で <department> 要素群を取得します。
59        foreach ($hospitalXml->departments->children() as $department) {
60            $departmentName = (string)$department['name']; // 'name'属性の値を取得
61            echo "部門: {$departmentName}" . PHP_EOL;
62
63            // 各部門の子要素（各'patient'要素）をループで処理します。
64            foreach ($department->children() as $patient) {
65                // 'patient'要素の属性と子要素のテキストコンテンツを取得します。
66                $patientId = (string)$patient['id'];
67                $patientName = (string)$patient->name;
68                $patientAge = (int)$patient->age;
69                echo "  患者ID: {$patientId}, 名前: {$patientName}, 年齢: {$patientAge}" . PHP_EOL;
70            }
71        }
72        echo PHP_EOL;
73
74        echo "--- 病院スタッフ情報 ---" . PHP_EOL;
75        // 'staff'要素の子要素（各'doctor'要素）をループで処理します。
76        foreach ($hospitalXml->staff->children() as $doctor) {
77            $specialization = (string)$doctor['specialization']; // 'specialization'属性の値を取得
78            $doctorName = (string)$doctor; // 要素自身のテキストコンテンツを取得
79            echo "  専門: {$specialization}, 医師名: {$doctorName}" . PHP_EOL;
80        }
81
82    } catch (Exception $e) {
83        // XMLのパースなどでエラーが発生した場合の処理
84        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
85    }
86}
87
88// 定義した関数を実行します。
89getHospitalInformation();

PHPのSimpleXMLElement::children()メソッドは、XMLデータから特定要素の直下にある子要素をまとめて取得するために使用されます。このメソッドは、SimpleXMLElementクラスに属し、XML構造を簡単にたどる際に非常に便利です。

引数$namespaceOrPrefixと$isPrefixを指定することで、特定名前空間に属する子要素のみをフィルタリングできますが、省略した場合はすべての直下の子要素が対象となります。戻り値は、取得された子要素を表すSimpleXMLElementオブジェクトの集合体（イテレート可能なオブジェクト）です。

提供されたサンプルコードでは、病院のXMLデータから部門や患者、スタッフ情報を取得する例を示しています。まず、XML文字列をSimpleXMLElementオブジェクトに変換し、$hospitalXml->children()でトップレベルの<departments>や<staff>といった子要素を取得しています。さらに、$hospitalXml->departments->children()のように連続して使用することで、<departments>内の各<department>要素、そしてその中の<patient>要素といったように、XMLの階層構造を効率的にたどって、小児科（Pediatrics）を含む各部門の患者情報や医師情報を抽出しています。このようにchildren()メソッドは、XMLデータの内容を構造的に読み解き、必要な情報にアクセスする際に役立つ基本的なメソッドです。