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

Copy
1<?php
2
3/**
4 * 指定されたディレクトリの内容を一覧表示します。
5 * DirectoryIterator::current() メソッドを使用して、現在のディレクトリ内の項目を取得する方法を示します。
6 *
7 * @param string $path 検査するディレクトリのパス。デフォルトは現在のディレクトリです。
8 * @return void
9 */
10function listDirectoryContentsWithCurrent(string $path = '.'): void
11{
12    try {
13        // DirectoryIteratorのインスタンスを作成します。
14        // パスとして '.' を指定すると、スクリプトが実行されている現在のディレクトリを指します。
15        $iterator = new DirectoryIterator($path);
16
17        echo "現在のディレクトリ: " . realpath($path) . "\n\n";
18        echo "ファイルとディレクトリのリスト:\n";
19
20        // イテレータが有効な位置にある間（つまり、まだ項目がある間）ループします。
21        while ($iterator->valid()) {
22            // current() メソッドを使用して、現在のイテレータ項目（DirectoryIterator オブジェクト）を取得します。
23            // このオブジェクトは、ファイルやディレクトリに関する情報を提供します。
24            $currentEntry = $iterator->current();
25
26            // getFilename() メソッドで現在の項目の名前（ファイル名またはディレクトリ名）を出力します。
27            echo "- " . $currentEntry->getFilename() . "\n";
28
29            // next() メソッドを呼び出して、イテレータを次の項目に進めます。
30            $iterator->next();
31        }
32    } catch (UnexpectedValueException $e) {
33        // 指定されたパスが有効なディレクトリでない場合に発生する例外を処理します。
34        echo "エラー: 指定されたパス '" . $path . "' が有効なディレクトリではありません。\n";
35        echo "詳細: " . $e->getMessage() . "\n";
36    } catch (Exception $e) {
37        // その他の予期せぬエラーをキャッチします。
38        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
39    }
40}
41
42// 関数を呼び出して、現在のスクリプトが実行されているディレクトリの内容を一覧表示します。
43listDirectoryContentsWithCurrent();
44
45// 例: 別のディレクトリを一覧表示する場合 (コメント解除して使用)
46// listDirectoryContentsWithCurrent('/tmp');
47?>

このPHPサンプルコードは、DirectoryIteratorクラスとcurrent()メソッドを使用して、指定されたディレクトリ内のファイルやサブディレクトリの名前を一覧表示する方法を示しています。

DirectoryIteratorクラスは、ディレクトリの内容を簡単に走査（一つずつ順に処理）するための機能を提供します。まず、new DirectoryIterator($path)で特定のディレクトリを対象としたイテレータを作成します。このコードでは、デフォルトで現在のディレクトリ（'.'）を対象としています。

current()メソッドは、引数を取らずに呼び出され、イテレータが現在指している項目（ファイルまたはディレクトリ）自体を表すDirectoryIteratorオブジェクトを返します。この返されたオブジェクトを通して、例えばgetFilename()メソッドを使ってその項目の名前を取得したり、isDir()やisFile()といったメソッドで種類を判別したりできます。

サンプルコードでは、while ($iterator->valid())ループを使って、まだ処理すべき項目がある間は繰り返し処理を行います。ループ内で$currentEntry = $iterator->current();として現在の項目を表すオブジェクトを取得し、$currentEntry->getFilename()でその名前を表示しています。その後、$iterator->next()を呼び出すことで、イテレータを次の項目へと進めます。このように、current()メソッドは、イテレータが指す現在の対象にアクセスするために不可欠な役割を果たします。

Copy
1<?php
2
3/**
4 * DirectoryIterator::current() メソッドを使用して、指定されたディレクトリ内の
5 * 現在の月に関連する要素を識別するサンプルコードです。
6 *
7 * この関数は一時ディレクトリを作成し、現在の月と前月の名前を持つサブディレクトリを作成します。
8 * その後、DirectoryIterator を使用してこれらのサブディレクトリを走査し、
9 * current() メソッドの戻り値がどのように利用できるかを示します。
10 */
11function processDirectoryForCurrentMonth(): void
12{
13    // 一時ディレクトリを作成し、現在の月と前月のディレクトリを準備
14    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'monthly_data_' . uniqid();
15    if (!mkdir($tempDir) && !is_dir($tempDir)) {
16        throw new RuntimeException(sprintf('Directory "%s" was not created', $tempDir));
17    }
18
19    $currentMonthNumeric = date('m'); // 例: "10" (現在の月)
20    $previousMonthNumeric = date('m', strtotime('-1 month')); // 例: "09" (前月)
21
22    mkdir($tempDir . DIRECTORY_SEPARATOR . $currentMonthNumeric);
23    mkdir($tempDir . DIRECTORY_SEPARATOR . $previousMonthNumeric);
24    file_put_contents($tempDir . DIRECTORY_SEPARATOR . $currentMonthNumeric . DIRECTORY_SEPARATOR . 'log.txt', 'This is a log file for the current month.');
25    file_put_contents($tempDir . DIRECTORY_SEPARATOR . $previousMonthNumeric . DIRECTORY_SEPARATOR . 'old_log.txt', 'This is a log file for the previous month.');
26
27    echo "--- Directory Scan for Current Month ---\n";
28    echo "Scanning base directory: {$tempDir}\n";
29    echo "Current month (numeric): {$currentMonthNumeric}\n\n";
30
31    try {
32        $iterator = new DirectoryIterator($tempDir);
33
34        foreach ($iterator as $fileInfo) {
35            // DirectoryIterator::current() メソッドは、イテレータが現在指している
36            // 要素（ファイルまたはディレクトリ）を DirectoryIterator オブジェクトとして返します。
37            // foreach ループ内で `$fileInfo` は `$iterator->current()` と同じオブジェクトを参照します。
38            // ここではメソッドの動作を示すために明示的に呼び出します。
39            $currentEntry = $iterator->current();
40
41            // ドットファイル (. および ..) はスキップします
42            if ($currentEntry->isDot()) {
43                continue;
44            }
45
46            // 要素の名前とタイプを表示
47            echo "Found entry: '{$currentEntry->getFilename()}' (Is Directory: " . ($currentEntry->isDir() ? 'Yes' : 'No') . ")\n";
48
49            // 現在の月を表すディレクトリかどうかをチェック
50            if ($currentEntry->isDir() && $currentEntry->getFilename() === $currentMonthNumeric) {
51                echo "  -> Identified as the directory for the current month!\n";
52                // この中で、さらに現在の月のディレクトリ内のファイルを処理するなどのロジックを追加できます。
53                // 例: $currentMonthFiles = new DirectoryIterator($currentEntry->getPathname());
54            }
55        }
56    } catch (UnexpectedValueException $e) {
57        echo "Error during directory iteration: " . $e->getMessage() . "\n";
58    } finally {
59        // 後処理: 作成した一時ディレクトリとその内容を削除
60        if (is_dir($tempDir)) {
61            echo "\nCleaning up temporary directory: {$tempDir}\n";
62            $files = new RecursiveIteratorIterator(
63                new RecursiveDirectoryIterator($tempDir, RecursiveDirectoryIterator::SKIP_DOTS),
64                RecursiveIteratorIterator::CHILD_FIRST
65            );
66
67            foreach ($files as $file) {
68                if ($file->isDir()) {
69                    rmdir($file->getPathname());
70                } else {
71                    unlink($file->getPathname());
72                }
73            }
74            rmdir($tempDir);
75        }
76        echo "--- Cleanup Complete ---\n";
77    }
78}
79
80// 関数を実行します
81processDirectoryForCurrentMonth();

PHPのDirectoryIterator::current()メソッドは、ディレクトリ内の要素を一つずつ処理する際に、イテレータが現在指しているファイルやサブディレクトリの情報を取得するために使用します。このメソッドは引数を必要とせず、現在指している要素を表すDirectoryIteratorオブジェクトを戻り値として返します。

通常、DirectoryIteratorオブジェクトをforeachループで走査する場合、foreach ($iterator as $fileInfo)のように記述すると、ループ変数である$fileInfoは自動的に$iterator->current()が返すものと同じDirectoryIteratorオブジェクトを参照します。そのため、明示的にcurrent()メソッドを呼び出さなくても、ループ変数を通じて現在の要素の名前や種類などの情報にアクセスできます。

サンプルコードでは、一時ディレクトリを作成し、現在の月と前月の名前を持つサブディレクトリを準備します。そしてDirectoryIteratorを使ってこれらを走査し、$iterator->current()を呼び出すことで、現在処理中の要素がどのディレクトリであるかを識別しています。このメソッドは、ディレクトリ内の個々の要素に対して特定の条件で処理を行いたい場合に役立ちます。