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

Copy
1<?php
2
3/**
4 * 現在のディレクトリを FilesystemIterator で走査し、
5 * FilesystemIterator::current() メソッドを使って各要素の情報を取得・表示します。
6 *
7 * この関数は、FilesystemIterator が返す SplFileInfo オブジェクトの利用方法を示します。
8 *
9 * @return void
10 */
11function listCurrentDirectoryContents(): void
12{
13    // 現在のディレクトリを示すパス
14    $directoryPath = '.';
15
16    try {
17        // FilesystemIterator のインスタンスを作成します。
18        // FilesystemIterator::SKIP_DOTS フラグは '.' (現在のディレクトリ) と '..' (親ディレクトリ) を
19        // 走査対象から除外することで、より関連性の高い結果を得られます。
20        $iterator = new FilesystemIterator($directoryPath, FilesystemIterator::SKIP_DOTS);
21
22        echo "現在のディレクトリ ('{$directoryPath}') の内容:\n";
23
24        // ディレクトリ内の各要素をループ処理します。
25        // foreach ループでは、自動的にイテレータが次の要素に進み、
26        // その要素の SplFileInfo オブジェクトが $file 変数に代入されます。
27        foreach ($iterator as $name => $file) {
28            // FilesystemIterator::current() メソッドは、
29            // 現在イテレータが指している要素（ファイルまたはディレクトリ）の
30            // SplFileInfo オブジェクトを明示的に返します。
31            // (foreach ループでは、$file 変数に既にこのオブジェクトが格納されていますが、
32            // current() メソッドの動作を示すためにここでは明示的に呼び出しています。)
33            $currentFileInfo = $iterator->current();
34
35            // SplFileInfo オブジェクトから、ファイルの種類、パス、サイズなどの情報を取得します。
36            $type = $currentFileInfo->isDir() ? 'ディレクトリ' : 'ファイル';
37            $path = $currentFileInfo->getPathname();
38            $sizeInfo = '';
39
40            // ファイルの場合のみサイズ情報を追加します。
41            if ($currentFileInfo->isFile()) {
42                $sizeInfo = ' (' . $currentFileInfo->getSize() . ' バイト)';
43            }
44
45            echo "- {$type}: {$path}{$sizeInfo}\n";
46        }
47    } catch (UnexpectedValueException $e) {
48        // 指定されたパスが存在しない、またはディレクトリでない場合に発生するエラーを捕捉します。
49        echo "エラー: ディレクトリ '{$directoryPath}' を読み込めませんでした。{$e->getMessage()}\n";
50    } catch (Exception $e) {
51        // その他の予期せぬエラーを捕捉します。
52        echo "予期せぬエラーが発生しました: {$e->getMessage()}\n";
53    }
54}
55
56// 関数を実行して、現在のディレクトリの内容を表示します。
57listCurrentDirectoryContents();

このPHPのサンプルコードは、FilesystemIteratorクラスとそのcurrent()メソッドを使用して、現在のディレクトリの内容をリストアップする方法をシステムエンジニアを目指す初心者向けに示しています。FilesystemIteratorは、ファイルシステムを効率的に走査するためのイテレータ（反復子）を提供します。

まず、現在のディレクトリを示すパス.を指定してFilesystemIteratorのインスタンスを作成します。この際、FilesystemIterator::SKIP_DOTSフラグを渡すことで、特殊なディレクトリである.（現在のディレクトリ）と..（親ディレクトリ）を走査対象から除外し、より関連性の高い結果のみを取得できるようにしています。

foreachループでイテレータを反復処理すると、ループごとにディレクトリ内の次の要素が取得され、その要素に関する情報を持つSplFileInfoオブジェクトが自動的に変数に格納されます。FilesystemIterator::current()メソッドは、このイテレータが現在指している要素のSplFileInfoオブジェクトを明示的に返します。このメソッドは引数を必要としません。

current()メソッドの戻り値であるSplFileInfoオブジェクトは、ファイルの種類（ディレクトリかファイルか）、完全なパス、ファイルサイズといった詳細な情報を提供します。サンプルコードでは、このSplFileInfoオブジェクトからこれらの情報を取得し、各要素の種類、パス、そしてファイルであればサイズを表示しています。これにより、ファイルシステム上の各要素について統一された方法で情報を取得・操作できることを示しています。また、指定されたパスが存在しない場合などに発生するエラーを捕捉するため、try-catchブロックによる例外処理も実装されています。

Copy
1<?php
2
3/**
4 * FilesystemIterator::current() メソッドの使用例を示します。
5 * 指定されたディレクトリ内の各ファイルやディレクトリについて、
6 * FilesystemIterator::current() が返す SplFileInfo オブジェクトから情報を取得し、
7 * そのファイルの最終更新月が現在の月と一致するかどうかを表示します。
8 */
9function demonstrateFilesystemIteratorCurrent(): void
10{
11    // 現在のスクリプトがあるディレクトリを対象とします。
12    // これにより、サンプルコードが単体で動作し、常に何らかのファイルシステム要素をイテレートできます。
13    $directoryPath = __DIR__;
14
15    // 現在の月を数値 (1～12) で取得します。
16    $currentMonth = (int) date('n');
17
18    echo "対象ディレクトリ: " . $directoryPath . PHP_EOL;
19    echo "現在の月: " . $currentMonth . PHP_EOL . PHP_EOL;
20
21    try {
22        // FilesystemIterator を初期化します。
23        // FilesystemIterator::CURRENT_AS_FILEINFO はデフォルトの挙動ですが、
24        // 明示することで current() メソッドが SplFileInfo オブジェクトを返すことを強調します。
25        $iterator = new FilesystemIterator($directoryPath, FilesystemIterator::CURRENT_AS_FILEINFO);
26
27        echo "ディレクトリ内の要素:" . PHP_EOL;
28        foreach ($iterator as $fileInfo) {
29            // FilesystemIterator::current() メソッドは、イテレータの現在の位置にある
30            // 要素の SplFileInfo オブジェクトを返します。
31            // foreach ループでは、$fileInfo 変数にこのオブジェクトが自動的に割り当てられます。
32            
33            // SplFileInfo オブジェクトから様々なファイル情報を取得できます。
34            $filename = $fileInfo->getFilename(); // ファイル名またはディレクトリ名
35            $path = $fileInfo->getPathname();   // フルパス
36            $type = $fileInfo->getType();       // 要素のタイプ (例: 'file', 'dir')
37
38            // ファイルの最終更新タイムスタンプから月を取得します。
39            $fileLastModifiedMonth = (int) date('n', $fileInfo->getMTime());
40
41            echo "- 名前: " . $filename . PHP_EOL;
42            echo "  パス: " . $path . PHP_EOL;
43            echo "  タイプ: " . $type . PHP_EOL;
44            echo "  最終更新月: " . $fileLastModifiedMonth;
45
46            // キーワード「current month」に関連付けて、現在の月と比較します。
47            if ($fileLastModifiedMonth === $currentMonth) {
48                echo " (現在の月と一致します)";
49            } else {
50                echo " (現在の月と一致しません)";
51            }
52            echo PHP_EOL . PHP_EOL;
53        }
54    } catch (UnexpectedValueException $e) {
55        // 指定されたディレクトリが存在しない、またはアクセス権がない場合に発生します。
56        echo "エラー: ディレクトリの読み込みに失敗しました - " . $e->getMessage() . PHP_EOL;
57    }
58}
59
60// サンプル関数を実行します。
61demonstrateFilesystemIteratorCurrent();
62

FilesystemIterator::current()メソッドは、PHPでディレクトリ内のファイルやサブディレクトリを効率的に巡回（イテレート）する際に使用されるFilesystemIteratorクラスの一部です。このメソッドは引数を取らずに呼び出され、イテレータが現在指し示しているファイルまたはディレクトリに関する詳細情報を持つSplFileInfoオブジェクトを返します。

SplFileInfoオブジェクトを利用すると、ファイル名、フルパス、ファイルの種類（ファイルかディレクトリか）、最終更新日時など、様々なファイルプロパティに統一された方法で簡単にアクセスできます。サンプルコードでは、現在のスクリプトがあるディレクトリを対象とし、FilesystemIteratorで各要素を巡回しています。foreachループを使用すると、FilesystemIterator::current()メソッドの戻り値であるSplFileInfoオブジェクトがループ変数に自動的に割り当てられます。

このオブジェクトからgetMTime()メソッドで最終更新タイムスタンプを取得し、date('n', ...)関数で最終更新月を抽出しています。その後、現在の月と比較することで、各要素の最終更新月が「php current month」と一致するかどうかを確認する具体的な例を示しています。このように、current()メソッドは、ディレクトリ内の各要素に対して詳細な情報へアクセスするための重要な手段となります。