【PHP8.x】RecursiveTreeIterator::PREFIX_END_HAS_NEXT定数の使い方

Copy
1<?php
2
3// ツリー構造のテスト用ディレクトリとファイルを作成します。
4function createTestTree(string $baseDir): void
5{
6    if (!is_dir($baseDir)) {
7        mkdir($baseDir, 0777, true);
8    }
9    // ディレクトリとファイルを複数作成し、ツリー構造をシミュレート
10    mkdir($baseDir . '/dirA', 0777, true);
11    file_put_contents($baseDir . '/dirA/fileA1.txt', 'content');
12    file_put_contents($baseDir . '/dirA/fileA2.txt', 'content'); // dirA内で兄弟要素が続く
13    mkdir($baseDir . '/dirB', 0777, true); // baseDir内で兄弟要素が続く
14    file_put_contents($baseDir . '/dirB/fileB1.txt', 'content');
15    file_put_contents($baseDir . '/file1.txt', 'content'); // baseDir内で兄弟要素が続く
16}
17
18// 作成した一時ファイルを削除し、クリーンアップします。
19function cleanUpTestTree(string $baseDir): void
20{
21    if (!is_dir($baseDir)) {
22        return;
23    }
24    $iterator = new RecursiveIteratorIterator(
25        new RecursiveDirectoryIterator($baseDir, FilesystemIterator::SKIP_DOTS),
26        RecursiveIteratorIterator::CHILD_FIRST
27    );
28    foreach ($iterator as $path) {
29        $path->isDir() && !$path->isLink() ? rmdir($path->getPathname()) : unlink($path->getPathname());
30    }
31    rmdir($baseDir);
32}
33
34$testBaseDir = __DIR__ . '/recursive_tree_example';
35
36// テスト用ツリーの作成
37createTestTree($testBaseDir);
38
39try {
40    // ディレクトリを再帰的に走査するイテレータを作成
41    $directoryIterator = new RecursiveDirectoryIterator($testBaseDir, FilesystemIterator::SKIP_DOTS);
42
43    // ディレクトリ構造をツリー形式で表示するためのイテレータを作成
44    // RecursiveIteratorIterator::SELF_FIRST を指定し、ディレクトリ自身も表示対象とします。
45    $treeIterator = new RecursiveTreeIterator($directoryIterator, RecursiveIteratorIterator::SELF_FIRST);
46
47    // RecursiveTreeIterator::PREFIX_END_HAS_NEXT は、現在の要素の後に兄弟要素が続く場合のプレフィックス部分を指します。
48    // この定数を使って、該当する行のプレフィックスをカスタマイズします。
49    // 例：デフォルトの "├── " のような表示を "├─(NEXT)─ " に変更します。
50    $treeIterator->setPrefixPart(RecursiveTreeIterator::PREFIX_END_HAS_NEXT, '├─(NEXT)─ ');
51
52    echo "--- カスタマイズされたツリー構造の表示 ---\n";
53    // ツリー構造をイテレートし、各要素とそのプレフィックスを出力
54    foreach ($treeIterator as $item) {
55        // getPrefix() メソッドは、現在の要素の前に表示されるツリープレフィックス文字列を返します。
56        // ここにカスタマイズした PREFIX_END_HAS_NEXT の値が適用されます。
57        echo $treeIterator->getPrefix() . $item->getFilename() . "\n";
58    }
59
60} catch (Exception $e) {
61    echo "エラーが発生しました: " . $e->getMessage() . "\n";
62} finally {
63    // 作成したテスト用ツリーをクリーンアップ
64    cleanUpTestTree($testBaseDir);
65}

PHPのRecursiveTreeIterator::PREFIX_END_HAS_NEXTは、RecursiveTreeIteratorクラスがツリー構造のデータを表示する際に使用する定数の一つです。この定数自体は引数を取らず、内部的に整数値（int）を返します。その役割は、ツリー構造において、現在の要素の後に同じ階層の兄弟要素がさらに続く場合に表示されるプレフィックス（前置記号）の部分を識別することです。

サンプルコードでは、ファイルシステムのディレクトリ構造をRecursiveTreeIteratorでツリー形式に表示しています。setPrefixPart()メソッドの第一引数にPREFIX_END_HAS_NEXT定数を指定し、第二引数にカスタム文字列（例: '├─(NEXT)─ '）を設定することで、プレフィックスをカスタマイズしています。これにより、あるディレクトリやファイルがリストされ、その後に同じ階層で別の兄弟要素が続く場合に、getPrefix()メソッドが返すデフォルトの「├── 」のような記号の代わりに、設定したカスタム文字列が出力されます。この機能を使うことで、ツリー表示の視認性を高め、兄弟要素がまだ続くことを明示的に示すなど、ツリー構造の視覚的な表現を柔軟に制御することができます。

Copy
1<?php
2
3/**
4 * RecursiveTreeIteratorとstr_ends_with関数の使用例を示します。
5 *
6 * この関数は、ファイルシステムのツリー構造を整形して表示し、
7 * PHP 8で導入されたstr_ends_with関数を使って、各エントリが特定の文字列で
8 * 終わるかをチェックする方法を示します。
9 * また、RecursiveTreeIterator::PREFIX_END_HAS_NEXT定数についても解説します。
10 */
11function demonstrateTreeIteratorAndStringEndCheck(): void
12{
13    // 動作確認用に一時的なディレクトリとファイルを作成します。
14    $tempDir = __DIR__ . '/temp_tree_data';
15    if (!is_dir($tempDir)) {
16        mkdir($tempDir);
17    }
18    file_put_contents($tempDir . '/document.txt', 'これはテキストファイルです。');
19    file_put_contents($tempDir . '/script.php', '<?php echo "Hello PHP!";');
20    mkdir($tempDir . '/src');
21    file_put_contents($tempDir . '/src/main.js', 'console.log("Hello JS!");');
22    file_put_contents($tempDir . '/src/config.ini', '[settings]');
23    mkdir($tempDir . '/empty_dir');
24
25    echo "--- RecursiveTreeIterator によるツリー表示と str_ends_with の適用 ---\n\n";
26
27    // RecursiveDirectoryIterator を使用して、指定されたディレクトリを再帰的にイテレートします。
28    // FilesystemIterator::SKIP_DOTS フラグは、'.' と '..' をスキップします。
29    $directoryIterator = new RecursiveDirectoryIterator($tempDir, FilesystemIterator::SKIP_DOTS);
30
31    // RecursiveTreeIterator は、RecursiveIterator を受け取り、ツリー構造を視覚的に表現する文字列を生成します。
32    $treeIterator = new RecursiveTreeIterator($directoryIterator);
33
34    // RecursiveTreeIterator::PREFIX_END_HAS_NEXT 定数の値を出力します。
35    // この定数は、RecursiveTreeIteratorがツリー表示のプレフィックス（例: "├── " や "└── "）を
36    // 生成する際に内部的に使用されるビットフラグの一部です。
37    // 具体的には、現在の要素の次に兄弟要素が存在する場合の行末記号に関連する部分を制御します。
38    // setPrefixPart() メソッドを使って、これらのプレフィックスをカスタマイズする際に利用できます。
39    echo "RecursiveTreeIterator::PREFIX_END_HAS_NEXT の値: " . RecursiveTreeIterator::PREFIX_END_HAS_NEXT . "\n\n";
40
41    // ツリーイテレータをループして、各ファイル/ディレクトリの表示とチェックを行います。
42    foreach ($treeIterator as $name => $fileInfo) {
43        // RecursiveTreeIterator::current() は、ツリー表示用のプレフィックスが付加された整形済み文字列を返します。
44        $displayPath = $treeIterator->current();
45
46        // 表示をきれいに保つため、行末の不要な空白を除去します。
47        echo rtrim($displayPath);
48
49        // PHP 8 で導入された str_ends_with() 関数を使用します。
50        // この関数は、文字列 ($haystack) が特定のサフィックス ($needle) で終わるかを効率的にチェックします。
51        if (str_ends_with($displayPath, '.php')) {
52            echo " (PHPスクリプト)";
53        } elseif (str_ends_with($displayPath, '.txt')) {
54            echo " (テキストファイル)";
55        } elseif (str_ends_with($displayPath, '/')) { // ディレクトリは通常 '/' で終わる形式で表示されます。
56            echo " (ディレクトリ)";
57        }
58
59        // PHP 7 以前で str_ends_with() と同等の機能を実現する方法 (参考情報)
60        /*
61        $suffix = '.php';
62        // 1. substr() と strlen() を使用する方法
63        if (substr($displayPath, -strlen($suffix)) === $suffix) {
64            // ...
65        }
66
67        // 2. 正規表現を使用する方法
68        if (preg_match('/\.php$/', $displayPath)) {
69            // ...
70        }
71        */
72        echo "\n";
73    }
74
75    // 後処理: 作成した一時ファイルとディレクトリを削除します。
76    $fileSystemIterator = new RecursiveDirectoryIterator($tempDir, FilesystemIterator::SKIP_DOTS);
77    $recursiveIterator = new RecursiveIteratorIterator($fileSystemIterator, RecursiveIteratorIterator::CHILD_FIRST);
78    foreach ($recursiveIterator as $file) {
79        if ($file->isDir()) {
80            rmdir($file->getPathname()); // 空のディレクトリを削除
81        } else {
82            unlink($file->getPathname()); // ファイルを削除
83        }
84    }
85    rmdir($tempDir); // 最上位の一時ディレクトリを削除
86
87    echo "\n--- 処理完了 ---\n";
88}
89
90// 関数を実行してデモンストレーションを開始します。
91demonstrateTreeIteratorAndStringEndCheck();

このサンプルコードは、PHP 8で導入されたstr_ends_with関数と、ファイルシステムなどの再帰的な構造をツリー形式で表示するRecursiveTreeIteratorクラスの使用方法を示しています。RecursiveTreeIteratorは、RecursiveDirectoryIteratorなどで取得したディレクトリ構造を「├── 」や「└── 」のようなプレフィックスを使って視覚的に分かりやすく整形します。

また、RecursiveTreeIterator::PREFIX_END_HAS_NEXT定数は、ツリー表示のプレフィックスを生成する際に、現在の要素に兄弟要素がある場合の行末記号を制御するビットフラグの一部です。これは引数を持たない整数（int）型の定数で、setPrefixPart()メソッドでプレフィックスをカスタマイズする際に利用できます。

PHP 8で追加されたstr_ends_with()関数は、ある文字列が特定のサフィックスで終わるかどうかを簡潔にチェックする機能を提供します。このコードでは、ツリー表示された各パスが「.php」や「.txt」で終わるかを効率的に判断しています。PHP 7以前のバージョンでは、substr()関数とstrlen()関数を組み合わせるなど、異なる方法で同様のチェックを行っていました。このサンプルコードは、これらの機能を組み合わせてファイルシステムツリーを表示しつつ、各エントリの種類を判別する具体的な例を示しています。