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

Copy
1<?php
2
3/**
4 * 現在のディレクトリとそのサブディレクトリをツリー構造で一覧表示する関数。
5 *
6 * RecursiveTreeIterator::current() メソッドを使用して、イテレータが指す現在の要素（ファイルまたはディレクトリ）
7 * の情報を取得し、表示します。
8 */
9function listCurrentDirectoryTree(): void
10{
11    // 現在の作業ディレクトリを取得します。
12    // キーワード「php current directory」に対応するため、getcwd() を使用します。
13    $currentDirectory = getcwd();
14
15    if ($currentDirectory === false) {
16        echo "エラー: 現在の作業ディレクトリを取得できませんでした。\n";
17        return;
18    }
19
20    echo "現在のディレクトリ (" . $currentDirectory . ") のツリー構造:\n";
21    echo "-----------------------------------------\n";
22
23    try {
24        // RecursiveDirectoryIterator は、指定されたディレクトリの内容を再帰的に走査するためのイテレータです。
25        // FilesystemIterator::SKIP_DOTS を指定することで、'.' (現在のディレクトリ) と '..' (親ディレクトリ) をスキップします。
26        $directoryIterator = new RecursiveDirectoryIterator(
27            $currentDirectory,
28            FilesystemIterator::SKIP_DOTS
29        );
30
31        // RecursiveTreeIterator は、RecursiveDirectoryIterator をツリー形式で表示するためのイテレータです。
32        // これを foreach で反復処理すると、ツリー構造を表現する整形済みの文字列が生成されます。
33        $treeIterator = new RecursiveTreeIterator($directoryIterator);
34
35        // ツリーイテレータを反復処理し、各要素（ファイルまたはディレクトリ）の情報を表示します。
36        foreach ($treeIterator as $path => $splFileInfo) {
37            // RecursiveTreeIterator::current() メソッドは、イテレータが現在指している要素の生の値（SplFileInfo オブジェクト）を返します。
38            // foreach ループで `$splFileInfo` 変数に既に値が渡されていますが、
39            // リファレンス情報で指定されたメソッドの使用を示すために明示的に呼び出します。
40            $currentElement = $treeIterator->current();
41
42            // $currentElement は SplFileInfo オブジェクトであり、ファイルやディレクトリに関する詳細情報を提供します。
43            // isDir() でディレクトリかどうかを判定し、getPathname() で要素の絶対パスを取得します。
44            $type = $currentElement->isDir() ? "ディレクトリ" : "ファイル";
45            $elementPath = $currentElement->getPathname();
46
47            // $path は RecursiveTreeIterator が生成する、ツリー構造を示す整形済みの文字列です。
48            echo sprintf("%s (%s: %s)\n", $path, $type, $elementPath);
49        }
50    } catch (UnexpectedValueException $e) {
51        // 指定されたパスが存在しない、アクセス権がないなどの場合に発生するエラーを捕捉します。
52        echo "エラー: " . $e->getMessage() . "\n";
53        echo "ディレクトリが存在しないか、アクセス権限がありません。\n";
54    }
55}
56
57// 関数を実行して、現在のディレクトリのツリー構造を表示します。
58listCurrentDirectoryTree();

このPHPコードは、現在の作業ディレクトリとそのサブディレクトリの内容をツリー形式で一覧表示する方法を紹介しています。まず、getcwd()関数で現在のディレクトリを取得し、これを基にRecursiveDirectoryIteratorを作成してディレクトリの内容を再帰的に走査します。

次に、このRecursiveDirectoryIteratorをRecursiveTreeIteratorに渡します。RecursiveTreeIteratorは、ディレクトリ構造を視覚的に分かりやすいツリー形式に整形して表示するための特殊なイテレータです。

foreachループでRecursiveTreeIteratorを反復処理すると、ツリー構造の各要素（ファイルやディレクトリ）が順番に処理されます。このループ内で使用されているRecursiveTreeIterator::current()メソッドは、引数なしで呼び出され、イテレータが現在指している要素の生の値、具体的にはSplFileInfoオブジェクトを返します。このSplFileInfoオブジェクトは、ファイルやディレクトリの名前、パス、種類（ファイルかディレクトリか）などの詳細な情報を含んでいます。

サンプルコードでは、current()メソッドで取得したSplFileInfoオブジェクトのisDir()メソッドで要素の種類を判別し、getPathname()メソッドでその絶対パスを取得しています。これにより、ツリー形式で表示される各行が、ファイルなのかディレクトリなのか、そしてその完全なパスが何かを正確に把握できるような出力を生成しています。current()メソッドは、イテレータの現在の位置にある要素の生のデータにアクセスしたい場合に役立ちます。

Copy
1<?php
2
3/**
4 * Demonstrates the use of RecursiveTreeIterator::current() by traversing a
5 * dynamically created directory structure representing years and months.
6 * It identifies and highlights the actual current month within this structure.
7 *
8 * This example aims to combine the functionality of RecursiveTreeIterator
9 * with a context related to the "current month" keyword for system engineer beginners.
10 */
11function demonstrateRecursiveTreeIteratorWithMonths(): void
12{
13    // --- 1. Create a dummy directory structure for demonstration ---
14    // A temporary base directory to avoid affecting actual file system
15    $baseDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_month_tree_demo_' . uniqid();
16    if (!mkdir($baseDir) && !is_dir($baseDir)) {
17        throw new \RuntimeException(sprintf('Directory "%s" was not created', $baseDir));
18    }
19
20    // Determine the current year and month for comparison
21    $actualCurrentYear = date('Y');
22    $actualCurrentMonthName = date('F'); // e.g., "January", "February"
23
24    // Define a range of years and all month names for the dummy structure
25    $years = [(int)$actualCurrentYear - 1, (int)$actualCurrentYear, (int)$actualCurrentYear + 1];
26    $months = [
27        'January', 'February', 'March', 'April', 'May', 'June',
28        'July', 'August', 'September', 'October', 'November', 'December'
29    ];
30
31    // Build the nested directory structure: year/month/report_file.txt
32    foreach ($years as $year) {
33        $yearPath = $baseDir . DIRECTORY_SEPARATOR . $year;
34        mkdir($yearPath);
35        foreach ($months as $month) {
36            $monthPath = $yearPath . DIRECTORY_SEPARATOR . $month;
37            mkdir($monthPath);
38            // Add a dummy file inside each month directory
39            file_put_contents($monthPath . DIRECTORY_SEPARATOR . 'report_' . strtolower($month) . '_' . $year . '.txt', "Data for $month $year");
40        }
41    }
42
43    // --- 2. Set up the RecursiveTreeIterator ---
44    // Create a RecursiveDirectoryIterator to read the contents of the base directory
45    $directoryIterator = new RecursiveDirectoryIterator(
46        $baseDir,
47        FilesystemIterator::SKIP_DOTS // Skips '.' and '..' entries
48    );
49
50    // Wrap it in RecursiveIteratorIterator to traverse subdirectories recursively
51    $recursiveIterator = new RecursiveIteratorIterator(
52        $directoryIterator,
53        RecursiveIteratorIterator::SELF_FIRST // Visits parent before its children
54    );
55
56    // Finally, wrap it in RecursiveTreeIterator to get the formatted tree output
57    $treeIterator = new RecursiveTreeIterator($recursiveIterator);
58
59    echo "--- Traversing a directory tree containing month data ---\n";
60
61    // --- 3. Iterate and demonstrate RecursiveTreeIterator::current() ---
62    foreach ($treeIterator as $key => $value) {
63        // Retrieve the current element using RecursiveTreeIterator::current().
64        // In this setup, it returns an SplFileInfo object for each file or directory.
65        $currentElement = $treeIterator->current();
66
67        // Get the name and full path of the current file or directory
68        $elementName = $currentElement->getFilename();
69        $elementPath = $currentElement->getPathname();
70
71        // Check if the current element is a month directory and matches the actual current month
72        $isMonthDirectory = $currentElement->isDir() && in_array($elementName, $months);
73        $isCurrentMonth = false;
74
75        if ($isMonthDirectory) {
76            // Check if the parent directory name matches the actual current year
77            $parentDirName = basename(dirname($elementPath));
78            if ($elementName === $actualCurrentMonthName && $parentDirName === $actualCurrentYear) {
79                $isCurrentMonth = true;
80            }
81        }
82
83        // Output the formatted tree prefix and the element name.
84        // Highlight if the element represents the actual current month.
85        $highlight = $isCurrentMonth ? " <<< THIS IS THE ACTUAL CURRENT MONTH!" : "";
86        echo $treeIterator->getPrefix() . $elementName . $highlight . "\n";
87    }
88
89    echo "--- End of traversal ---\n";
90
91    // --- 4. Clean up the dummy directory structure ---
92    // Anonymous recursive function to remove a directory and its contents
93    $rrmdir = function ($dir) use (&$rrmdir) {
94        if (is_dir($dir)) {
95            $objects = scandir($dir);
96            foreach ($objects as $object) {
97                if ($object !== "." && $object !== "..") {
98                    if (is_dir($dir . DIRECTORY_SEPARATOR . $object)) {
99                        $rrmdir($dir . DIRECTORY_SEPARATOR . $object);
100                    } else {
101                        unlink($dir . DIRECTORY_SEPARATOR . $object);
102                    }
103                }
104            }
105            rmdir($dir);
106        }
107    };
108    $rrmdir($baseDir);
109}
110
111// Execute the demonstration function
112demonstrateRecursiveTreeIteratorWithMonths();
113
114?>

PHPのRecursiveTreeIterator::current()メソッドは、ツリー構造を再帰的に走査する際に、現在処理している要素（ファイルやディレクトリ）を取得するために使用されます。このメソッドは引数を必要とせず、現在の要素を表すSplFileInfoオブジェクトなどのmixed型の値を返します。SplFileInfoオブジェクトからは、ファイル名、パス、種類（ディレクトリかファイルか）といった詳細情報にアクセスできます。

提供されたサンプルコードでは、まず一時ディレクトリ内に年と月の階層構造を持つ仮想的なディレクトリを作成しています。次に、RecursiveTreeIteratorを使ってこの仮想的なディレクトリ構造を再帰的に走査します。ループ内でcurrent()メソッドを呼び出すことで、現在処理しているファイルやディレクトリの情報を取得しています。取得した情報を用いて、現在の要素が実際の現在の年月と一致する月ディレクトリであるかを判定し、その情報をハイライトして表示しています。

このようにcurrent()メソッドを活用することで、複雑なファイルシステムやデータ構造を効率的に探索し、特定の情報を見つけ出す処理を実装できることを示しています。システムエンジニアの業務でファイルやディレクトリの操作を行う際に役立つ基本的な機能です。