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

Copy
1<?php
2
3/**
4 * DirectoryIterator::getFileInfo() メソッドの使用例を示します。
5 * 指定されたディレクトリ内の各エントリ（ファイルまたはサブディレクトリ）について、
6 * その詳細なファイル情報を取得し、表示します。
7 *
8 * システムエンジニアを目指す初心者の方へ:
9 * このコードは、特定のディレクトリの中身を調べて、
10 * それぞれがファイルなのかディレクトリなのか、名前は何か、といった情報を得る方法を示しています。
11 * `DirectoryIterator`は、ディレクトリ内の要素を一つずつ順番に見ていくための道具です。
12 * `getFileInfo()`は、今見ている要素に関するより詳しい情報（`SplFileInfo`オブジェクト）を
13 * 取り出すために使われます。
14 */
15
16// 対象とするディレクトリのパスを設定します。
17// __DIR__ は、このスクリプトが置かれているディレクトリの絶対パスを指します。
18$targetDirectory = __DIR__;
19
20echo "--- ディレクトリ: {$targetDirectory} のファイル情報一覧 ---\n";
21echo "---------------------------------------------------\n";
22
23try {
24    // DirectoryIterator のインスタンスを作成します。
25    // これにより、$targetDirectory 内の各ファイルやサブディレクトリを順に処理できるようになります。
26    $iterator = new DirectoryIterator($targetDirectory);
27
28    // ディレクトリ内の各エントリ（ファイルやディレクトリ）をループ処理します。
29    // $entry は DirectoryIterator のオブジェクトで、現在のエントリを表します。
30    foreach ($iterator as $entry) {
31        // DirectoryIterator::getFileInfo() メソッドを呼び出し、
32        // 現在のエントリに関する SplFileInfo オブジェクトを取得します。
33        // SplFileInfo オブジェクトは、ファイル名、パス、サイズ、最終変更日時など、
34        // ファイルに関する豊富な情報を提供します。
35        $splFileInfo = $entry->getFileInfo();
36
37        // 取得した SplFileInfo オブジェクトから情報を取得し、表示します。
38        $type = '不明';
39        if ($splFileInfo->isDir()) {
40            $type = 'ディレクトリ'; // エントリがディレクトリの場合
41        } elseif ($splFileInfo->isFile()) {
42            $type = 'ファイル';     // エントリがファイルの場合
43        }
44
45        $name = $splFileInfo->getFilename(); // ファイル名またはディレクトリ名
46        $path = $splFileInfo->getPathname(); // ファイルまたはディレクトリのフルパス
47        $size = $splFileInfo->isFile() ? $splFileInfo->getSize() . ' バイト' : '-'; // ファイルサイズ (ディレクトリの場合は'-')
48
49        // 取得した情報を整形して出力します。
50        echo "タイプ: {$type}, 名前: {$name}, フルパス: {$path}, サイズ: {$size}\n";
51    }
52
53    echo "---------------------------------------------------\n";
54
55} catch (UnexpectedValueException $e) {
56    // 指定されたディレクトリが存在しない、またはアクセス権がない場合に発生するエラーです。
57    echo "エラー: 指定されたディレクトリが見つからないか、アクセスできません。\n";
58    echo "詳細: " . $e->getMessage() . "\n";
59} catch (Exception $e) {
60    // その他の予期せぬエラーが発生した場合にキャッチします。
61    echo "予期せぬエラーが発生しました。\n";
62    echo "詳細: " . $e->getMessage() . "\n";
63}
64
65?>

PHPのDirectoryIterator::getFileInfo()メソッドは、DirectoryIteratorが現在指しているファイルやディレクトリに関する詳細な情報を取得するために使用されます。DirectoryIteratorは、指定されたディレクトリ内の各エントリ（ファイルまたはサブディレクトリ）を順に処理するためのクラスです。

このメソッドは、引数としてオプションでSplFileInfoのサブクラスを指定できますが、何も指定しない場合はデフォルトでSplFileInfoオブジェクトを返します。戻り値であるSplFileInfoオブジェクトは、ファイル名、パス、サイズ、最終変更日時、種類（ファイルかディレクトリか）など、ファイルやディレクトリに関する豊富な情報を提供します。

サンプルコードでは、まず対象ディレクトリのDirectoryIteratorを作成し、foreachループでディレクトリ内の各エントリを順に処理します。ループ内で各エントリに対してgetFileInfo()を呼び出し、その詳細情報を持つSplFileInfoオブジェクトを取得しています。その後、SplFileInfoオブジェクトのisDir()やisFile()メソッドでエントリの種類を判断し、getFilename()、getPathname()、getSize()などのメソッドを使って具体的な情報を抽出し、整形して出力しています。このコードは、ファイルシステムをプログラムから操作し、ディレクトリの内容を調査する基本的な手法を示しています。