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

Copy
1<?php
2
3/**
4 * Demonstrates how to use SplTempFileObject::getSize() to
5 * retrieve the size of a temporary file created in memory or on disk.
6 * This is useful for handling file-like data without direct filesystem interaction
7 * until persistence is needed.
8 */
9function getTempFileSizeExample(): void
10{
11    // 1. SplTempFileObject のインスタンスを作成します。
12    //    これは、一時的なファイルのように扱えるオブジェクトで、
13    //    デフォルトでは指定されたサイズまでメモリにデータを保持し、
14    //    それを超えると一時的なディスクファイルに書き出します。
15    $tempFile = new SplTempFileObject();
16
17    // 2. 一時ファイルに内容を書き込みます。
18    //    この文字列のバイト長がファイルのサイズになります。
19    $content = "これはSplTempFileObjectのテストです。\n";
20    $content .= "この行もファイルのサイズに含まれます。\n";
21    
22    $bytesWritten = $tempFile->fwrite($content);
23
24    // 書き込みが成功したか確認します。
25    if ($bytesWritten === false) {
26        echo "エラー: 一時ファイルへの書き込みに失敗しました。\n";
27        return;
28    }
29
30    // 3. SplTempFileObject::getSize() を使用して、一時ファイルのサイズを取得します。
31    //    戻り値はバイト単位の整数、または失敗時に false です。
32    $fileSize = $tempFile->getSize();
33
34    // 4. 取得したサイズを確認し、出力します。
35    if ($fileSize === false) {
36        echo "エラー: 一時ファイルのサイズを取得できませんでした。\n";
37    } else {
38        echo "一時ファイルに書き込まれたバイト数: {$bytesWritten} バイト\n";
39        echo "SplTempFileObject::getSize() で取得したファイルサイズ: {$fileSize} バイト\n";
40
41        // 書き込んだ内容の実際のバイト長と、取得したファイルサイズが一致するか検証します。
42        if ($fileSize === strlen($content)) {
43            echo "検証成功: 報告されたファイルサイズは書き込んだ内容のバイト長と一致します。\n";
44        } else {
45            echo "検証失敗: 報告されたファイルサイズが書き込んだ内容のバイト長と一致しません。\n";
46        }
47    }
48
49    // スクリプトの終了時にSplTempFileObjectは自動的にクリーンアップされます。
50}
51
52// 関数を実行してデモンストレーションを開始します。
53getTempFileSizeExample();
54
55?>

PHPのSplTempFileObject::getSize()メソッドは、メモリ内または一時ディスク上にファイルのように扱えるSplTempFileObjectオブジェクトに格納されているデータのバイト数を取得するために使用されます。このSplTempFileObjectクラスは、実際のファイルシステムに書き込む前に、一時的なファイルデータをプログラム内で効率的に管理する際に非常に便利です。

getSize()メソッドは、引数を一切必要とせず、呼び出すだけで現在のデータサイズを返します。戻り値は、ファイルサイズをバイト単位で示す整数（int）型です。もし何らかの理由でサイズの取得に失敗した場合は、falseが返されます。

サンプルコードでは、まずSplTempFileObjectのインスタンスを作成し、そこに任意の文字列をfwrite()メソッドで書き込んでいます。その後、getSize()を呼び出すことで、書き込まれた内容の正確なバイト数を取得できることを示しています。これにより、実際のファイルシステムを直接操作することなく、一時的なデータの大きさを簡単に把握することが可能です。スクリプトの終了時には、この一時ファイルは自動的にクリーンアップされます。