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

Copy
1<?php
2
3/**
4 * Demonstrates the use of FilesystemIterator::next() to iterate through files.
5 * This example simulates inspecting a 'pages' directory within a Next.js project
6 * to list its contents, showing how a PHP script might interact with such a structure.
7 */
8function listNextJsPages(): void
9{
10    // Define a path for a temporary directory to simulate a Next.js 'pages' folder.
11    // In a real application, this would be the actual path to your Next.js project's 'pages' directory.
12    $simulatedNextJsPagesDir = __DIR__ . '/temp_nextjs_pages_example';
13
14    // --- Setup: Create dummy files for demonstration ---
15    if (!is_dir($simulatedNextJsPagesDir)) {
16        mkdir($simulatedNextJsPagesDir, 0777, true);
17    }
18    file_put_contents($simulatedNextJsPagesDir . '/index.js', '// Next.js index page component');
19    file_put_contents($simulatedNextJsPagesDir . '/about.js', '// Next.js about page component');
20    file_put_contents($simulatedNextJsPagesDir . '/products.js', '// Next.js products page component');
21    mkdir($simulatedNextJsPagesDir . '/blog', 0777, true);
22    file_put_contents($simulatedNextJsPagesDir . '/blog/first-post.js', '// Next.js blog post page');
23    // --- End Setup ---
24
25    echo "--- Listing files in a simulated Next.js 'pages' directory ---\n";
26
27    try {
28        // Initialize FilesystemIterator for the specified directory.
29        // It provides information about files and directories in the filesystem.
30        $iterator = new FilesystemIterator($simulatedNextJsPagesDir);
31
32        // Loop while the iterator is valid (i.e., there are more items to process).
33        while ($iterator->valid()) {
34            // Get the current SplFileInfo object representing the file or directory.
35            $fileInfo = $iterator->current();
36
37            // Display information about the current item.
38            echo "- " . $fileInfo->getFilename();
39            if ($fileInfo->isDir()) {
40                echo " (Directory)";
41            }
42            echo "\n";
43
44            // Move the iterator to the next item.
45            // This is the FilesystemIterator::next() method call,
46            // which advances the internal pointer to the next entry in the directory.
47            $iterator->next();
48        }
49    } catch (UnexpectedValueException $e) {
50        // Catch potential errors, e.g., if the directory does not exist or is not readable.
51        echo "Error: Could not iterate directory. " . $e->getMessage() . "\n";
52    } finally {
53        // --- Cleanup: Remove dummy files and directory ---
54        echo "\n--- Cleaning up temporary files and directory ---\n";
55        if (is_dir($simulatedNextJsPagesDir)) {
56            $files = new RecursiveIteratorIterator(
57                new RecursiveDirectoryIterator($simulatedNextJsPagesDir, RecursiveDirectoryIterator::SKIP_DOTS),
58                RecursiveIteratorIterator::CHILD_FIRST
59            );
60            foreach ($files as $file) {
61                $file->isDir() ? rmdir($file->getRealPath()) : unlink($file->getRealPath());
62            }
63            rmdir($simulatedNextJsPagesDir);
64        }
65        // --- End Cleanup ---
66    }
67}
68
69// Execute the demonstration function.
70listNextJsPages();

このPHPコードは、FilesystemIteratorクラスのnext()メソッドを利用して、ディレクトリ内のファイルを順番に処理する方法を示しています。FilesystemIteratorは、ファイルシステムを効率的に巡回し、その内容に関する情報を提供するPHPの標準クラスです。

サンプルコードでは、Next.jsプロジェクトのpagesディレクトリに見立てた一時的なディレクトリを作成し、複数のダミーファイルを用意しています。まず、この一時ディレクトリを対象としてFilesystemIteratorのインスタンスを生成します。

コードの中心となるループでは、while ($iterator->valid())によって、まだ処理すべきファイルやディレクトリが残っているかを確認します。ループ内では$iterator->current()を使って現在のファイルやディレクトリの詳細な情報（SplFileInfoオブジェクト）を取得し、その名前を表示しています。

この処理の重要な部分が$iterator->next()メソッドの呼び出しです。このメソッドは引数を一切受け取らず、戻り値もありません。その唯一の役割は、FilesystemIteratorが内部的に保持しているポインタを次のファイルまたはディレクトリへと移動させることです。これにより、次のループでvalid()メソッドが新しい要素を正しく検出し、current()メソッドがその新しい要素の情報を提供できるようになります。

最後に、このコードは作成した一時ファイルとディレクトリを確実に削除するクリーンアップ処理も含んでおり、next()メソッドがディレクトリ内の要素を一つずつ順番に辿るために不可欠な役割を果たしていることを示しています。

Copy
1<?php
2
3/**
4 * ネットワークサービスに関連するディレクトリ内のファイルをリストアップする例。
5 *
6 * この関数はFilesystemIteratorを使用してディレクトリの内容を走査します。
7 * FilesystemIterator::next() メソッドの動作を明示的に示すために、
8 * foreach ループではなく while ループと next() を組み合わせて使用します。
9 *
10 * 「ネットワーク」というキーワードを直接扱うわけではありませんが、
11 * ウェブサーバーの公開ディレクトリや共有フォルダなど、
12 * ネットワーク経由でアクセスされる可能性のあるファイルシステムを想定しています。
13 */
14function listNetworkRelatedFiles(): void
15{
16    // 一時ディレクトリを作成し、ネットワークサービスが利用するディレクトリを模倣します。
17    // これにより、サンプルコードが単体で動作し、クリーンアップも容易になります。
18    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'network_content_' . uniqid();
19
20    // ディレクトリ作成に失敗した場合はエラーを出力して終了
21    if (!mkdir($tempDir) && !is_dir($tempDir)) {
22        echo "エラー: 一時ディレクトリの作成に失敗しました: " . $tempDir . PHP_EOL;
23        return;
24    }
25
26    // ダミーファイルとサブディレクトリを作成し、サンプルデータとします。
27    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'index.html', '<html><body>Hello!</body></html>');
28    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'app.js', '// JavaScript code');
29    mkdir($tempDir . DIRECTORY_SEPARATOR . 'assets');
30    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'assets' . DIRECTORY_SEPARATOR . 'style.css', '/* CSS */');
31
32    echo "模擬的なネットワーク関連ディレクトリ '" . $tempDir . "' の内容をリストアップします:" . PHP_EOL;
33
34    try {
35        // FilesystemIterator を初期化します。
36        // FilesystemIterator::SKIP_DOTS を設定することで、特殊なディレクトリ「.」と「..」をスキップします。
37        $iterator = new FilesystemIterator($tempDir, FilesystemIterator::SKIP_DOTS);
38
39        // next() メソッドの動作を明示的に示すため、while ループを使用します。
40        // valid() メソッドは、イテレータが有効な要素を指しているかを確認します。
41        while ($iterator->valid()) {
42            // current() メソッドは、イテレータが現在指している要素の SplFileInfo オブジェクトを返します。
43            $fileInfo = $iterator->current();
44
45            // ファイル名またはディレクトリ名とその種類を出力します。
46            $type = $fileInfo->isDir() ? "ディレクトリ" : ($fileInfo->isFile() ? "ファイル" : "その他");
47            echo "  - " . $fileInfo->getFilename() . " (" . $type . ")" . PHP_EOL;
48
49            // next() メソッドを呼び出して、イテレータを次の要素に進めます。
50            // これがこのサンプルの主要なポイントです。
51            $iterator->next();
52        }
53    } catch (UnexpectedValueException $e) {
54        // 指定されたパスがディレクトリでない場合や、読み取り権限がない場合に発生する可能性があります。
55        echo "エラー: ディレクトリの読み込みに失敗しました: " . $e->getMessage() . PHP_EOL;
56    } finally {
57        // サンプル実行後、作成した一時ディレクトリとファイルをクリーンアップします。
58        // rmdir() は空のディレクトリしか削除できないため、再帰的に削除するヘルパー関数を使用します。
59        $recursiveDelete = function (string $dir) use (&$recursiveDelete): bool {
60            if (!is_dir($dir)) {
61                return false;
62            }
63            $files = array_diff(scandir($dir), ['.', '..']);
64            foreach ($files as $file) {
65                $path = $dir . DIRECTORY_SEPARATOR . $file;
66                (is_dir($path) && !is_link($path)) ? $recursiveDelete($path) : unlink($path);
67            }
68            return rmdir($dir);
69        };
70
71        if (is_dir($tempDir)) {
72            $recursiveDelete($tempDir);
73            echo "一時ディレクトリ '" . $tempDir . "' をクリーンアップしました。" . PHP_EOL;
74        }
75    }
76}
77
78// 関数を実行します。
79listNetworkRelatedFiles();
80
81?>

このPHPコードは、FilesystemIteratorクラスを利用して、特定のディレクトリ内のファイルやフォルダを順番に処理する方法を示すものです。サンプルでは、ウェブサーバーの公開ディレクトリのように、ネットワーク経由でアクセスされる可能性のあるファイルシステムを想定し、その内容をリストアップしています。

まず、FilesystemIteratorのインスタンスを作成し、対象となるディレクトリを指定して初期化します。while ($iterator->valid())ループは、まだ処理すべき次の項目があるかを確認し、$iterator->current()で現在イテレータが指しているファイルやフォルダの情報を取得します。

ここで重要なのは、FilesystemIterator::next()メソッドです。これは、イテレータが現在指している位置を、ディレクトリ内の次のファイルまたはディレクトリへと移動させる役割を持ちます。このメソッドは引数を一切取らず、また、移動が成功したことなどを明示的に示す戻り値もありません。next()を呼び出すことで、イテレータは内部的に更新され、ループの次の反復で新しい項目にアクセスできるようになります。これにより、ディレクトリ内のすべての項目を順序立てて効率的に走査することが可能になります。