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

Copy
1<?php
2
3/**
4 * 指定されたファイルのサイズをバイト単位で取得し、表示します。
5 *
6 * SplFileInfo クラスと getSize() メソッドを使用して、ファイルの情報を扱います。
7 * システムエンジニアを目指す初心者向けに、基本的なファイル操作の一例を示します。
8 *
9 * @param string $filePath サイズを取得したいファイルのパス
10 * @return void
11 */
12function getAndDisplayFileSize(string $filePath): void
13{
14    // 1. ファイルが存在するかどうかを確認します。
15    //    存在しないファイルに対して操作を試みるとエラーになるため、事前にチェックすることが重要です。
16    if (!file_exists($filePath)) {
17        echo "エラー: ファイル '{$filePath}' が見つかりません。\n";
18        return;
19    }
20
21    try {
22        // 2. SplFileInfo オブジェクトを作成します。
23        //    これはファイルに関する様々な情報（サイズ、パス、権限など）を操作するためのPHP標準クラスです。
24        $fileInfo = new SplFileInfo($filePath);
25
26        // 3. getSize() メソッドを呼び出してファイルサイズを取得します。
27        //    このメソッドはファイルサイズをバイト単位で整数値（int）として返します。
28        $fileSize = $fileInfo->getSize();
29
30        // 4. 取得したファイルサイズを表示します。
31        echo "ファイル '{$filePath}' のサイズ: {$fileSize} バイト\n";
32
33    } catch (RuntimeException $e) {
34        // 5. 例外処理: SplFileInfo のインスタンス化や操作中にエラーが発生した場合にキャッチします。
35        //    例えば、パスが無効な場合などに発生することがあります。
36        echo "エラー: ファイル情報の取得中に問題が発生しました: " . $e->getMessage() . "\n";
37    }
38}
39
40// --- サンプルコードの実行例 ---
41
42// 一時的なテストファイルを作成します。
43// このファイルは、getSize() メソッドの動作確認のために使用されます。
44$testFilePath = 'my_example_file.txt';
45$fileContent = 'これは SplFileInfo::getSize() メソッドの動作を確認するためのサンプルテキストです。';
46file_put_contents($testFilePath, $fileContent); // ファイルに内容を書き込みます。
47
48// 作成したファイルのサイズを取得して表示します。
49getAndDisplayFileSize($testFilePath);
50
51// 存在しないファイルのサイズを取得しようとする例も示します。
52// 上記の関数内のエラーハンドリングが動作することを確認できます。
53getAndDisplayFileSize('non_existent_file.txt');
54
55// テストが完了したら、作成した一時ファイルを削除してクリーンアップします。
56if (file_exists($testFilePath)) {
57    unlink($testFilePath); // ファイルを削除します。
58}

PHP 8 の SplFileInfo::getSize() メソッドは、指定されたファイルのサイズをバイト単位で取得するために使用されます。このメソッドは、PHPの標準ライブラリ（SPL）の一部である SplFileInfo クラスに属しており、ファイルやディレクトリに関するさまざまな情報をオブジェクト指向的に扱うことを可能にします。

SplFileInfo クラスを利用するには、まずファイルパスを引数としてそのクラスの新しいインスタンスを作成します。このインスタンスを通して、ファイルの様々な属性にアクセスできるようになります。getSize() メソッドは引数を一切受け取らず、呼び出すだけで対象ファイルのサイズを整数値（int）として返します。戻り値の単位は常にバイトです。

提供されたサンプルコードでは、getAndDisplayFileSize 関数内でこのメソッドの具体的な使用例が示されています。ファイル操作を行う前には、file_exists() 関数でファイルが実際に存在するかを確認することが重要です。これにより、存在しないファイルに対して操作を試みることによるエラーを防ぎます。また、SplFileInfo のインスタンス化やメソッドの実行中に予期せぬ問題（例えば、無効なファイルパスなど）が発生する可能性に備え、try-catch ブロックを用いた例外処理が実装されています。これにより、エラー発生時でもプログラムが安全に動作し、適切なメッセージを表示できます。この機能は、システムのファイル管理やディスク使用量の監視など、幅広い場面で活用されます。