【PHP8.x】XMLReader::isEmptyElementプロパティの使い方

Copy
1<?php
2
3/**
4 * Parses an XML string, extracts item values, and filters out values that are empty
5 * or originate from self-closing XML elements.
6 *
7 * This function demonstrates the use of XMLReader, specifically the isEmptyElement property,
8 * in conjunction with common PHP array filtering techniques to achieve the goal of
9 * "deleting empty array elements" based on XML content.
10 *
11 * @param string $xmlString The XML string to parse.
12 * @return array A filtered array containing only non-empty, non-whitespace item values.
13 */
14function processAndFilterXmlItems(string $xmlString): array
15{
16    $reader = new XMLReader();
17
18    // Attempt to open the provided XML string for parsing.
19    if (!$reader->XML($xmlString)) {
20        // Return an empty array if the XML string cannot be opened.
21        // In a real application, more robust error handling might be needed.
22        return [];
23    }
24
25    $itemValues = [];
26
27    // Loop through each node in the XML document until no more nodes are available.
28    while ($reader->read()) {
29        // We are specifically interested in element nodes with the name 'item'.
30        if ($reader->nodeType === XMLReader::ELEMENT && $reader->name === 'item') {
31            // Check if the current XML element is a self-closing tag (e.g., <item/>).
32            // The XMLReader::isEmptyElement property returns true for such tags.
33            if ($reader->isEmptyElement) {
34                // If it's a self-closing element, it inherently has no content.
35                // We add an empty string to our list, which will later be filtered out.
36                $itemValues[] = '';
37            } else {
38                // If it's not a self-closing element, it might contain text content.
39                // Use readString() to get all text content within the current element.
40                // This method also conveniently advances the reader past the element's end tag.
41                $value = $reader->readString();
42
43                // Trim leading/trailing whitespace to treat strings like "   " as empty.
44                $itemValues[] = trim($value);
45            }
46        }
47    }
48
49    // Close the XMLReader to release resources.
50    $reader->close();
51
52    // The core step for "deleting empty array elements":
53    // array_filter() without a callback removes all elements that evaluate to false.
54    // This includes empty strings (''), null, 0, false, and empty arrays.
55    // This effectively removes the empty strings added for self-closing elements
56    // and elements whose trimmed text content was empty.
57    $filteredValues = array_filter($itemValues);
58
59    return $filteredValues;
60}
61
62// --- Example Usage ---
63// Define an XML string with various types of 'item' elements to demonstrate filtering.
64$xmlData = <<<XML
65<items>
66    <item id="1">First Value</item>
67    <item id="2"/> <!-- This is a self-closing element (isEmptyElement is true) -->
68    <item id="3">Second Value</item>
69    <item id="4"></item> <!-- Element with empty content (isEmptyElement is false, but readString() is '') -->
70    <item id="5">   </item> <!-- Element with whitespace content (isEmptyElement is false, trim() makes it '') -->
71    <item id="6">Third Value</item>
72    <item id="7">  Value with leading/trailing spaces  </item>
73    <item id="8"/>
74</items>
75XML;
76
77// Process the XML and get the filtered array of item values.
78$resultArray = processAndFilterXmlItems($xmlData);
79
80// To demonstrate the output, you would typically print it:
81/*
82echo "Filtered Item Values:\n";
83print_r($resultArray);
84*/
85// Expected output:
86// Filtered Item Values:
87// Array
88// (
89//     [0] => First Value
90//     [1] => Second Value
91//     [2] => Third Value
92//     [3] => Value with leading/trailing spaces
93// )

このサンプルコードは、PHPのXMLReaderクラスが提供するisEmptyElementプロパティを活用し、XMLデータから特定の要素の値を抽出し、空の値を効率的にフィルタリングする方法を示しています。

processAndFilterXmlItems関数は、処理対象のXML文字列を$xmlString引数として受け取ります。関数内部では、XMLReaderがXMLを読み進めながら、<item>という名前の要素を探します。

$reader->isEmptyElementプロパティは、現在のXML要素が<item/>のような自己終了タグである場合にtrue（真）を返します。このプロパティによって、子要素やテキスト内容を持たない要素を正確に判別できます。要素が自己終了タグである場合や、内容が空または空白のみの場合は、一時的に空文字列として配列に追加します。それ以外の要素からは実際のテキスト内容を抽出し、前後の空白を除去（trim）して配列に入れます。

最後に、集められた値の配列に対してarray_filter()関数を適用します。array_filter()は、コールバック関数を指定しない場合、空文字列やnull、0、falseといった「偽」と評価される要素を配列から自動的に取り除きます。この処理により、自己終了タグや内容が空だった要素に対応する空の文字列が効果的に配列から「削除」されます。

関数の戻り値は、XMLデータから抽出された、空でも空白のみでもない有効な値だけを含む配列（array）です。このコードは、XMLの内容に基づいて不要な空の配列要素を取り除く具体的な手法を提供しています。

Copy
1<?php
2
3/**
4 * XML文字列をパースし、指定された要素のテキストコンテンツを抽出、
5 * さらに抽出された配列から空の要素を削除します。
6 *
7 * この関数はXMLReader::isEmptyElementプロパティの挙動を踏まえつつ、
8 * キーワード「php remove empty element from array」に焦点を当て、
9 * 配列操作の基本であるarray_filter関数を効果的に使用する例を示します。
10 *
11 * @param string $xmlString パースするXMLデータ
12 * @param string $targetElementName 抽出対象の要素名
13 * @return array 処理済みのテキストコンテンツの配列。空の要素は含まれません。
14 */
15function extractAndCleanXmlElements(string $xmlString, string $targetElementName = 'item'): array
16{
17    $reader = new XMLReader();
18    // XMLデータのロードを試みる
19    if (!$reader->xml($xmlString)) {
20        // ロードに失敗した場合、空の配列を返す
21        return [];
22    }
23
24    $extractedData = [];
25
26    // XMLノードを一つずつ読み込む
27    while ($reader->read()) {
28        // 現在のノードが要素であり、かつ指定された要素名と一致する場合
29        if ($reader->nodeType === XMLReader::ELEMENT && $reader->name === $targetElementName) {
30            // readString() は現在の要素のテキストコンテンツを読み込みます。
31            // XMLReader::isEmptyElementがtrueとなる <tag/> 形式の要素の場合でも、
32            // readString()は空文字列を返します。
33            // また、<tag></tag> や <tag>   </tag> のような要素も同様に空文字列や空白のみの文字列を返します。
34            // そのため、isEmptyElementのチェックを明示的に行わずとも、後続のarray_filterで処理できます。
35            // trim() で前後の空白を除去します。
36            $content = trim($reader->readString());
37            $extractedData[] = $content;
38        }
39    }
40    $reader->close(); // XMLReaderインスタンスを閉じる
41
42    // キーワード「php remove empty element from array」に対応する部分。
43    // array_filterはコールバック関数を省略すると、
44    // 'false' と評価されるすべての要素（例: '', null, false, 0, [] など）を配列から削除します。
45    // これにより、XMLから抽出された空の文字列や空白のみの文字列が除去されます。
46    // array_valuesは、要素削除によって生じたキーのギャップを埋め、0から始まる新しいインデックスに振り直します。
47    $cleanedArray = array_filter($extractedData);
48
49    return array_values($cleanedArray);
50}
51
52// --- サンプルコードの実行例 ---
53
54// サンプルXMLデータ
55$sampleXml = '
56<root>
57    <item>First value</item>
58    <item></item>
59    <item>Second value</item>
60    <item/>
61    <anotherTag>This is not an item</anotherTag>
62    <item>   Third value   </item>
63    <item>Fourth value</item>
64    <item>  </item>
65</root>';
66
67// 関数を呼び出して、XMLから'item'要素のテキストコンテンツを抽出し、空要素を除去
68$result = extractAndCleanXmlElements($sampleXml, 'item');
69
70// 結果を出力して確認
71echo "処理後の配列:\n";
72print_r($result);
73
74// 追加のテストケース
75$testXml = '<data><node1>Value1</node1><node2/><node3></node3><node4>  </node4><node5>Value2</node5></data>';
76$testResult = extractAndCleanXmlElements($testXml, 'node');
77echo "\n追加テストケースの処理後の配列:\n";
78print_r($testResult);

このPHPコードは、XMLデータから特定の要素のテキスト内容を取り出し、さらに抽出された配列から空の要素を削除するextractAndCleanXmlElements関数を説明しています。

関数はまずXMLReaderクラスを用いてXMLデータを効率的に読み込みます。指定された要素名に一致するノードが見つかると、readString()メソッドでそのテキスト内容を取得します。XMLReader::isEmptyElementプロパティは、<tag/>のような空の要素を識別しますが、readString()はこれらの要素や空白のみの要素に対しても空文字列を返すため、このプロパティを直接確認せずとも後の処理で対応可能です。取得したテキストはtrim()で前後の空白を除去し、一時的な配列に格納されます。

次に、キーワードである「配列から空の要素を削除」を実現するため、array_filter()関数が使われます。この関数はコールバック関数を省略すると、空文字列、null、false、0などの「偽」と評価される値を配列から自動的に取り除きます。これにより、抽出された空のテキスト要素が除去されます。最後にarray_values()で、要素削除によって生じたキーのずれを直し、配列のインデックスを0から振り直します。

この関数は、パースするXML文字列（$xmlString）と抽出対象の要素名（$targetElementName）を引数として受け取り、空の要素が取り除かれたテキストコンテンツの配列を戻り値として返します。