【PHP8.x】RecursiveIteratorIterator::LEAVES_ONLY定数の使い方

Copy
1<?php
2
3/**
4 * RecursiveIteratorIterator::LEAVES_ONLY 定数を使用して、
5 * ディレクトリ構造の「葉」（ファイルのみ）を走査するサンプルコードです。
6 *
7 * システムエンジニアを目指す初心者向けに、具体的なファイルの概念で
8 * 「葉」の動作を理解しやすくしています。
9 */
10
11/**
12 * テスト用のディレクトリとファイル構造を作成します。
13 *
14 * @param string $baseDir 作成するルートディレクトリのパス。
15 * @return void
16 */
17function createTestDirectoryStructure(string $baseDir): void
18{
19    // ルートディレクトリを作成
20    if (!mkdir($baseDir, 0777, true) && !is_dir($baseDir)) {
21        throw new RuntimeException(sprintf('Directory "%s" was not created', $baseDir));
22    }
23
24    // ファイルとサブディレクトリを作成
25    file_put_contents($baseDir . '/file_a.txt', 'Content A');
26
27    $subDir1 = $baseDir . '/sub_dir_1';
28    if (!mkdir($subDir1) && !is_dir($subDir1)) {
29        throw new RuntimeException(sprintf('Directory "%s" was not created', $subDir1));
30    }
31    file_put_contents($subDir1 . '/file_b.txt', 'Content B');
32
33    $subDir2 = $subDir1 . '/sub_dir_2';
34    if (!mkdir($subDir2) && !is_dir($subDir2)) {
35        throw new RuntimeException(sprintf('Directory "%s" was not created', $subDir2));
36    }
37    file_put_contents($subDir2 . '/file_c.txt', 'Content C');
38
39    $subDir3 = $baseDir . '/sub_dir_3';
40    if (!mkdir($subDir3) && !is_dir($subDir3)) {
41        throw new RuntimeException(sprintf('Directory "%s" was not created', $subDir3));
42    }
43    file_put_contents($subDir3 . '/file_d.txt', 'Content D');
44
45    echo "テスト用ディレクトリ構造が作成されました: " . realpath($baseDir) . "\n";
46}
47
48/**
49 * 指定されたディレクトリとその内容を再帰的に削除します。
50 *
51 * @param string $dirPath 削除するディレクトリのパス。
52 * @return void
53 */
54function deleteTestDirectoryStructure(string $dirPath): void
55{
56    if (!is_dir($dirPath)) {
57        return;
58    }
59
60    $files = new RecursiveIteratorIterator(
61        new RecursiveDirectoryIterator($dirPath, RecursiveDirectoryIterator::SKIP_DOTS),
62        RecursiveIteratorIterator::CHILD_FIRST
63    );
64
65    foreach ($files as $fileinfo) {
66        if ($fileinfo->isDir()) {
67            rmdir($fileinfo->getRealPath());
68        } else {
69            unlink($fileinfo->getRealPath());
70        }
71    }
72    rmdir($dirPath);
73    echo "テスト用ディレクトリ構造が削除されました: " . $dirPath . "\n";
74}
75
76/**
77 * RecursiveIteratorIterator::LEAVES_ONLY 定数の使用例を示します。
78 * ディレクトリ構造から「葉」（ファイル）のみを抽出します。
79 *
80 * @return void
81 */
82function demonstrateRecursiveIteratorLeavesOnly(): void
83{
84    // 一意なテストディレクトリ名を生成
85    $testDir = __DIR__ . '/temp_test_dir_' . uniqid();
86
87    try {
88        // テスト用ディレクトリ構造を作成
89        createTestDirectoryStructure($testDir);
90
91        echo "\nRecursiveIteratorIterator::LEAVES_ONLY を使用してファイル（葉要素）のみを走査:\n";
92        echo "---------------------------------------------------------\n";
93
94        // RecursiveDirectoryIterator を使用してディレクトリを再帰的に走査する準備
95        // SKIP_DOTS は . と .. をスキップするために使用します
96        $directoryIterator = new RecursiveDirectoryIterator(
97            $testDir,
98            FilesystemIterator::SKIP_DOTS
99        );
100
101        // RecursiveIteratorIterator を初期化し、LEAVES_ONLY モードを指定します。
102        // LEAVES_ONLY を設定すると、ディレクトリ自体はスキップされ、
103        // ファイルのような子を持たない要素（葉）のみがイテレートされます。
104        $iterator = new RecursiveIteratorIterator(
105            $directoryIterator,
106            RecursiveIteratorIterator::LEAVES_ONLY
107        );
108
109        // イテレータをループし、取得された要素を表示
110        foreach ($iterator as $fileInfo) {
111            // $fileInfo は SplFileInfo オブジェクトです
112            echo "葉要素 (ファイル): " . $fileInfo->getPathname() . "\n";
113        }
114        echo "---------------------------------------------------------\n";
115
116    } catch (Exception $e) {
117        echo "エラーが発生しました: " . $e->getMessage() . "\n";
118    } finally {
119        // テスト用ディレクトリ構造を確実にクリーンアップ
120        deleteTestDirectoryStructure($testDir);
121    }
122}
123
124// 関数を実行
125demonstrateRecursiveIteratorLeavesOnly();

PHP 8のRecursiveIteratorIterator::LEAVES_ONLYは、階層構造を持つデータを効率的に走査するためのRecursiveIteratorIteratorクラスに指定する定数です。この定数を使用すると、イテレータは構造の「葉」にあたる要素のみを処理対象とします。例えばファイルシステムを走査する場合、「葉」はディレクトリの中にあるファイルそのものを指し、ディレクトリ自身はスキップされます。

サンプルコードでは、まず一時的なディレクトリ構造を作成し、その中にいくつかのファイルとサブディレクトリを配置しています。その後、RecursiveDirectoryIteratorを使ってこのディレクトリ構造全体を読み込む準備をし、それをRecursiveIteratorIteratorに渡す際にLEAVES_ONLY定数を指定しています。これにより、foreachループでイテレータを走査すると、作成したディレクトリの中からファイル（file_a.txt、file_b.txtなど）だけが順番に抽出され、そのパスが表示されます。サブディレクトリ自体は表示されません。この定数は引数を取らず、内部的には整数値を返します。ファイルだけを対象に処理を行いたい場合に、余計なディレクトリ情報を除外して効率的にコードを記述できる便利な機能です。

Copy
1<?php
2
3/**
4 * ネストされた配列から末端の要素（葉ノード）のみを抽出し、表示します。
5 * RecursiveIteratorIterator::LEAVES_ONLY 定数を使用することで、
6 * 再帰的な走査において、子要素を持たない末端の要素のみが処理の対象となります。
7 *
8 * @param array $data 走査するネストされた配列
9 */
10function displayLeavesOnly(array $data): void
11{
12    // RecursiveArrayIterator は、通常のPHP配列を再帰的にイテレート可能なオブジェクトに変換します。
13    $recursiveArrayIterator = new RecursiveArrayIterator($data);
14
15    // RecursiveIteratorIterator は、RecursiveIterator インターフェースを実装するオブジェクトを
16    // 再帰的に走査するためのイテレータです。
17    // 第2引数に RecursiveIteratorIterator::LEAVES_ONLY を指定すると、
18    // 中間ノード（つまり、他の配列を含む要素）はスキップされ、
19    // 末端の要素（値を持つ要素で、これ以上ネストされていないもの）のみが返されます。
20    $iterator = new RecursiveIteratorIterator(
21        $recursiveArrayIterator,
22        RecursiveIteratorIterator::LEAVES_ONLY
23    );
24
25    echo "--- ネストされた配列の末端要素（LEAVES_ONLY モード） ---\n";
26
27    // イテレータをループして、末端の要素とその値を取得し表示します。
28    foreach ($iterator as $key => $value) {
29        echo "キー: '{$key}', 値: '{$value}'\n";
30    }
31}
32
33// サンプルデータ: 複数レベルでネストされた配列
34$sampleData = [
35    'category_a' => 'item_a1',
36    'category_b' => [
37        'subcategory_b1' => 'item_b1_1',
38        'subcategory_b2' => [
39            'item_b2_1', // 数値キーでアクセスされる
40            'item_b2_2'
41        ],
42        'subcategory_b3' => 'item_b3_1'
43    ],
44    'category_c' => 'item_c1'
45];
46
47// 関数を実行し、結果を表示
48displayLeavesOnly($sampleData);
49
50?>

このPHPコードは、ネストされた配列から末端の要素（葉ノード）のみを抽出し、表示する方法を示しています。

まず、displayLeavesOnly関数は、引数で受け取った配列をRecursiveArrayIteratorに変換します。これにより、通常のPHP配列を再帰的に走査可能なオブジェクトにします。

次に、このRecursiveArrayIteratorをRecursiveIteratorIteratorのコンストラクタに渡します。ここで重要なのは、第2引数にRecursiveIteratorIterator::LEAVES_ONLY定数を指定している点です。この定数（整数値）を指定すると、イテレータは子要素を持つ中間ノードをスキップし、それ以上ネストされていない末端の要素（値）だけを処理の対象とします。

最終的に、foreachループを使ってイテレータを走査すると、LEAVES_ONLYモードによって抽出された末端の要素のキーと値だけが順番に取り出され、画面に表示されます。この定数を利用することで、複雑な階層構造のデータから目的の情報を効率的にフィルタリングし、取得することが可能です。