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

Copy
1<?php
2
3/**
4 * 指定されたディレクトリ内のトップレベルファイルのサイズを表示します。
5 * RecursiveDirectoryIterator::getSize() メソッドの使用例を示します。
6 *
7 * @param string $directoryPath 走査するディレクトリのパス
8 */
9function displayFileSizesInDirectory(string $directoryPath): void
10{
11    // サンプルコードが単体で動作するように、一時的なディレクトリとファイルを作成します。
12    // 実際には、既存のディレクトリパスを指定して使用します。
13    if (!is_dir($directoryPath)) {
14        if (!mkdir($directoryPath, 0777, true)) {
15            echo "エラー: ディレクトリ '{$directoryPath}' を作成できませんでした。\n";
16            return;
17        }
18    }
19
20    // デモンストレーション用のファイルを作成
21    $tempFile1 = $directoryPath . '/sample_document.txt';
22    $tempFile2 = $directoryPath . '/data_log.csv';
23    $tempSubDir = $directoryPath . '/nested_folder';
24
25    file_put_contents($tempFile1, 'これはテストファイルの内容です。'); // 30 バイト (UTF-8)
26    file_put_contents($tempFile2, str_repeat('A', 100)); // 100 バイト
27    mkdir($tempSubDir, 0777); // サブディレクトリは getSize() では通常0バイトと表示されるか、
28                             // この例ではファイルとして扱われないため出力されません。
29
30    echo "ディレクトリ '{$directoryPath}' 内のトップレベルファイルのサイズ:\n";
31
32    try {
33        // RecursiveDirectoryIterator のインスタンスを作成します。
34        // FilesystemIterator::SKIP_DOTS フラグは '.' と '..' エントリをスキップします。
35        $iterator = new RecursiveDirectoryIterator(
36            $directoryPath,
37            FilesystemIterator::SKIP_DOTS
38        );
39
40        // イテレータをループして各エントリにアクセスします。
41        // ここでの $item は RecursiveDirectoryIterator のインスタンスです。
42        // このクラスは SplFileInfo のメソッドも持ちます。
43        foreach ($iterator as $item) {
44            // 現在のエントリがファイルであるかを確認します。
45            if ($item->isFile()) {
46                $fileName = $item->getFilename();
47                // getSize() メソッドを使用してファイルのサイズをバイト単位で取得します。
48                $fileSize = $item->getSize(); // 戻り値は int 型
49                echo sprintf("- %s: %d バイト\n", $fileName, $fileSize);
50            }
51        }
52    } catch (UnexpectedValueException $e) {
53        echo "エラー: ディレクトリ '{$directoryPath}' を開けませんでした。メッセージ: " . $e->getMessage() . "\n";
54    } finally {
55        // デモ用に作成したファイルとディレクトリをクリーンアップします。
56        if (file_exists($tempFile1)) {
57            unlink($tempFile1);
58        }
59        if (file_exists($tempFile2)) {
60            unlink($tempFile2);
61        }
62        if (is_dir($tempSubDir)) {
63            rmdir($tempSubDir);
64        }
65        // ディレクトリが空の場合のみ削除します。
66        if (is_dir($directoryPath) && count(scandir($directoryPath)) <= 2) {
67            rmdir($directoryPath);
68        }
69    }
70}
71
72// サンプルコードを実行するための、一時的なディレクトリパスを定義します。
73$demoDirectory = __DIR__ . DIRECTORY_SEPARATOR . 'php_getsize_example_dir';
74displayFileSizesInDirectory($demoDirectory);

PHPのRecursiveDirectoryIterator::getSize()メソッドは、ディレクトリ内のファイルサイズを取得するために使用されます。このメソッドは、RecursiveDirectoryIteratorクラスのインスタンスがファイルを表す際に利用できる機能で、指定されたディレクトリとその中のサブディレクトリを効率的に探索し、見つかった個々のファイルのサイズを把握したい場合に特に役立ちます。

getSize()メソッドは引数を必要とせず、呼び出すと対象のファイルのサイズをバイト単位の整数値（int型）として返します。たとえば、サンプルコードでは、RecursiveDirectoryIteratorを使ってディレクトリ内の各エントリを順に処理し、isFile()メソッドでそれがファイルであることを確認した後に、getSize()を呼び出してそのファイルの具体的なサイズを取得しています。これにより、ディレクトリ内の各ファイルの容量を正確に確認でき、ログファイルのサイズ監視やストレージ使用量の集計など、さまざまなシステム管理タスクに応用することができます。