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

Copy
1<?php
2
3/**
4 * RecursiveIteratorIterator::SELF_FIRST 定数の動作をデモンストレーションします。
5 *
6 * この関数は、一時的なディレクトリ構造を作成し、
7 * RecursiveIteratorIterator を RecursiveIteratorIterator::SELF_FIRST モードで初期化して走査します。
8 * これにより、ディレクトリ自体がその内容よりも先にリストされる順序が示されます。
9 */
10function demonstrateSelfFirstIterator(): void
11{
12    // 一時ディレクトリを作成し、サンプルファイルを配置します。
13    // RecursiveIteratorIterator の動作を確認するための構造です。
14    $baseDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_self_first_demo_' . uniqid();
15
16    // 次のようなディレクトリとファイルの階層を作成します:
17    // /baseDir/
18    // ├── file1.txt
19    // └── sub_dir_A/
20    //     ├── file2.txt
21    //     └── sub_dir_B/
22    //         └── file3.txt
23    mkdir($baseDir);
24    mkdir($baseDir . DIRECTORY_SEPARATOR . 'sub_dir_A');
25    file_put_contents($baseDir . DIRECTORY_SEPARATOR . 'file1.txt', 'Content 1');
26    file_put_contents($baseDir . DIRECTORY_SEPARATOR . 'sub_dir_A' . DIRECTORY_SEPARATOR . 'file2.txt', 'Content 2');
27    mkdir($baseDir . DIRECTORY_SEPARATOR . 'sub_dir_A' . DIRECTORY_SEPARATOR . 'sub_dir_B');
28    file_put_contents($baseDir . DIRECTORY_SEPARATOR . 'sub_dir_A' . DIRECTORY_SEPARATOR . 'sub_dir_B' . DIRECTORY_SEPARATOR . 'file3.txt', 'Content 3');
29
30    echo "一時ディレクトリを作成しました: " . $baseDir . PHP_EOL;
31    echo "---------------------------------------------------" . PHP_EOL;
32
33    try {
34        // RecursiveDirectoryIterator を作成します。
35        // FilesystemIterator::SKIP_DOTS は、特殊なエントリ "." と ".." をスキップします。
36        $directoryIterator = new RecursiveDirectoryIterator($baseDir, FilesystemIterator::SKIP_DOTS);
37
38        // RecursiveIteratorIterator を RecursiveIteratorIterator::SELF_FIRST モードで初期化します。
39        //
40        // この定数は、RecursiveIteratorIterator が反復処理する順序を制御します。
41        // RecursiveIteratorIterator::SELF_FIRST を指定すると、
42        // イテレータは「現在の要素（ディレクトリ自体など、'self'が指すもの）」を先に処理し、
43        // その後にそのディレクトリに含まれる子要素を処理します。
44        //
45        // キーワード「php selfとは」に関して:
46        // PHPにおける「self」キーワードは通常、クラス内で静的メンバーを参照するために使われますが、
47        // ここでの「SELF_FIRST」の「SELF」は、イテレータが指し示す現在のノード（自己）を意味し、
48        // そのノード自体を子ノードより先に反復処理することを示します。
49        $iterator = new RecursiveIteratorIterator(
50            $directoryIterator,
51            RecursiveIteratorIterator::SELF_FIRST
52        );
53
54        echo "RecursiveIteratorIterator::SELF_FIRST モードでの走査順序:" . PHP_EOL;
55        foreach ($iterator as $fileInfo) {
56            // 各要素（ファイルまたはディレクトリ）のフルパスを出力します。
57            // 出力順序に注目してください。親ディレクトリがその子要素より先に表示されます。
58            echo "  " . $fileInfo->getPathname() . PHP_EOL;
59        }
60
61        echo "---------------------------------------------------" . PHP_EOL;
62
63    } catch (UnexpectedValueException $e) {
64        // ディレクトリが見つからないなどのエラーを捕捉します。
65        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
66    } finally {
67        // 作成した一時ディレクトリとファイルをクリーンアップします。
68        // ネストされたディレクトリを再帰的に削除するためのヘルパー関数 (クロージャ) です。
69        $rrmdir = static function (string $dir) use (&$rrmdir): bool {
70            if (!file_exists($dir)) {
71                return true;
72            }
73            if (!is_dir($dir)) {
74                return unlink($dir); // ファイルの場合
75            }
76            foreach (scandir($dir) as $item) {
77                if ($item == '.' || $item == '..') {
78                    continue;
79                }
80                if (!$rrmdir($dir . DIRECTORY_SEPARATOR . $item)) {
81                    return false;
82                }
83            }
84            return rmdir($dir); // ディレクトリを削除
85        };
86
87        if ($rrmdir($baseDir)) {
88            echo "一時ディレクトリを削除しました: " . $baseDir . PHP_EOL;
89        } else {
90            echo "一時ディレクトリの削除に失敗しました: " . $baseDir . PHP_EOL;
91        }
92    }
93}
94
95// デモンストレーション関数を実行します。
96demonstrateSelfFirstIterator();

PHPのRecursiveIteratorIterator::SELF_FIRSTは、ディレクトリやファイルの階層構造を効率的に巡回するRecursiveIteratorIteratorクラスで利用される定数です。この定数は、イテレータが階層を走査する順序を制御する役割を持ちます。引数はなく、内部的には整数値（int）として定義されています。

SELF_FIRSTを指定すると、イテレータは「現在の要素（ディレクトリ自体など）」を、その要素が含む「子要素（ファイルやサブディレクトリ）」よりも先に処理します。サンプルコードでは、一時的に作成されたbaseDirという親ディレクトリが、その中のfile1.txtやsub_dir_Aといった子要素よりも先にリストされる動作が確認できます。これは、ファイルシステムの探索において、親要素から順に処理を進めたい場合に特に便利です。

キーワード「php selfとは」に関して、PHPのプログラミングにおいて通常selfは、クラス内で静的なメンバーを参照するために使われる特殊なキーワードです。しかし、このSELF_FIRST定数におけるSELFは、イテレータが現在指し示しているノード「自分自身」を意味し、通常のselfキーワードとは文脈が異なります。この定数を理解することで、ファイルシステムの探索においてより柔軟な制御が可能になります。

Copy
1<?php
2
3/**
4 * RecursiveIteratorIterator::SELF_FIRST 定数の動作をデモンストレーションする関数。
5 *
6 * この定数は RecursiveIteratorIterator のコンストラクタに渡すことで、
7 * 再帰的なイテレーションにおいて、現在の要素（ディレクトリ自体）をその子要素よりも先に処理するよう指定します。
8 *
9 * システムエンジニアを目指す初心者の方へ:
10 * ディレクトリツリーのように階層構造を持つデータを扱う際、
11 * どの順番で各要素を処理するかは非常に重要です。SELF_FIRST を指定すると、
12 * 「まず親ディレクトリについて何かしらの処理を行い、その後に中のファイルやサブディレクトリを処理する」
13 * といったシナリオに適しています。
14 */
15function demonstrateRecursiveIteratorIteratorSelfFirst(): void
16{
17    // 1. テスト用のディレクトリ構造を作成
18    $baseDir = __DIR__ . '/temp_recursive_iterator_test';
19
20    // 既に存在する場合は削除してクリーンな状態にする
21    if (is_dir($baseDir)) {
22        // 既存のディレクトリを安全に削除するためのヘルパー関数
23        $deleteDir = function (string $dir) use (&$deleteDir) {
24            $files = array_diff(scandir($dir), ['.', '..']);
25            foreach ($files as $file) {
26                $path = $dir . '/' . $file;
27                is_dir($path) ? $deleteDir($path) : unlink($path);
28            }
29            return rmdir($dir);
30        };
31        $deleteDir($baseDir);
32    }
33    mkdir($baseDir);
34
35    // サブディレクトリとファイルを作成
36    $filesToCreate = [
37        'file0.txt' => 'Root file',
38        'subdir1/file1.txt' => 'Subdir1 file',
39        'subdir1/subsubdir1/file1_1.txt' => 'Subsubdir1 file',
40        'subdir2/file2.txt' => 'Subdir2 file',
41    ];
42
43    foreach ($filesToCreate as $path => $content) {
44        $fullPath = $baseDir . '/' . $path;
45        $dir = dirname($fullPath);
46        if (!is_dir($dir)) {
47            mkdir($dir, 0777, true); // 親ディレクトリも再帰的に作成
48        }
49        file_put_contents($fullPath, $content);
50    }
51
52    echo "--- RecursiveIteratorIterator::SELF_FIRST によるディレクトリツリー走査 ---" . PHP_EOL;
53    echo "（ディレクトリ自体を先に、その後に子要素を処理する順序）" . PHP_EOL . PHP_EOL;
54
55    try {
56        // RecursiveDirectoryIterator を使ってディレクトリツリーを初期化
57        // SKIP_DOTS フラグで "." と ".." のエントリをスキップ
58        $directoryIterator = new RecursiveDirectoryIterator(
59            $baseDir,
60            RecursiveDirectoryIterator::SKIP_DOTS
61        );
62
63        // RecursiveIteratorIterator を使用して再帰的にイテレート
64        // RecursiveIteratorIterator::SELF_FIRST 定数を指定することで、
65        // 親ディレクトリが子要素よりも先に処理・出力されます。
66        $recursiveIterator = new RecursiveIteratorIterator(
67            $directoryIterator,
68            RecursiveIteratorIterator::SELF_FIRST
69        );
70
71        // 各要素をループで処理
72        foreach ($recursiveIterator as $path => $fileInfo) {
73            // 現在の要素の深さに応じてインデントを調整
74            $indent = str_repeat('  ', $recursiveIterator->getDepth());
75            $type = $fileInfo->isDir() ? 'DIR' : 'FILE';
76            echo $indent . $type . ': ' . $fileInfo->getFilename() . PHP_EOL;
77        }
78
79    } catch (Exception $e) {
80        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
81    } finally {
82        // 2. テスト用のディレクトリ構造をクリーンアップ
83        // 実際の本番環境で一時ファイルを生成・削除する場合は、セキュリティや権限に注意が必要です。
84        if (is_dir($baseDir)) {
85            echo PHP_EOL . "--- クリーンアップ中 ---" . PHP_EOL;
86            try {
87                // ディレクトリを安全に削除するためには、子要素から先に削除する必要があります。
88                // そのため、ここでは CHILD_FIRST フラグを使用します。
89                $dirIterForCleanup = new RecursiveDirectoryIterator($baseDir, RecursiveDirectoryIterator::SKIP_DOTS);
90                $iterForCleanup = new RecursiveIteratorIterator(
91                    $dirIterForCleanup,
92                    RecursiveIteratorIterator::CHILD_FIRST // 子要素から先に削除
93                );
94
95                foreach ($iterForCleanup as $file) {
96                    if ($file->isDir()) {
97                        rmdir($file->getRealPath());
98                    } else {
99                        unlink($file->getRealPath());
100                    }
101                }
102                rmdir($baseDir); // 最後にルートディレクトリを削除
103                echo "一時ディレクトリ '" . $baseDir . "' を削除しました。" . PHP_EOL;
104            } catch (Exception $e) {
105                echo "クリーンアップ中にエラーが発生しました: " . $e->getMessage() . PHP_EOL;
106            }
107        }
108    }
109}
110
111// 関数を実行してデモンストレーションを開始
112demonstrateRecursiveIteratorIteratorSelfFirst();

PHPのRecursiveIteratorIterator::SELF_FIRST定数は、RecursiveIteratorIteratorクラスで使用され、階層構造を持つデータを再帰的に処理する際のイテレーション順序を制御します。この定数をRecursiveIteratorIteratorのコンストラクタに渡すと、イテレーターは現在の要素（親ディレクトリなど）を、その子要素よりも先に処理するようになります。

例えば、ファイルシステムを走査する際にSELF_FIRSTを指定すると、まずディレクトリ自体が出力や処理の対象となり、その後にそのディレクトリ内のファイルやサブディレクトリが処理されます。これは、親ディレクトリに対して何らかの事前処理（アクセス権の確認など）を行ってから、その中身を操作するようなシナリオで役立ちます。

SELF_FIRST定数自体は引数を取りませんが、その値はint型です。この定数を活用することで、システムエンジニアが階層データを扱う際、親要素から子要素へと順序良く処理を進める「事前順序（pre-order）」での走査を簡単に実装できます。これは、特定のディレクトリを処理してからその内容にアクセスするなど、階層データの管理において重要な機能です。