【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()メソッドがディレクトリ内の要素を一つずつ順番に辿るために不可欠な役割を果たしていることを示しています。