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

Copy
1<?php
2
3/**
4 * SplTempFileObject を使用してファイルの内容を切り詰める (truncate) 例を示します。
5 * システムエンジニアを目指す初心者向けに、ファイル操作の基本と ftruncate の動作を簡潔に示します。
6 *
7 * SplTempFileObject は一時ファイルを作成し、スクリプト終了時に自動的に削除するため、
8 * ファイル操作のテストや一時的なデータ処理に適しています。
9 */
10function demonstrateSplTempFileObjectTruncation(): void
11{
12    // SplTempFileObject のインスタンスを作成します。
13    // これはメモリ上またはディスク上に一時ファイルを生成します。
14    $file = new SplTempFileObject();
15
16    // ファイルに初期内容を書き込みます。
17    $initialContent = "これはサンプルファイルの内容です。\nこのテキストは切り詰められます。\n";
18    $file->fwrite($initialContent);
19    echo "--- 初期状態 ---\n";
20    echo "書き込んだ内容: " . $initialContent;
21    echo "初期ファイルサイズ: " . $file->fstat()['size'] . " バイト\n\n";
22
23    // ファイルポインタを先頭に戻します。
24    // ftruncate を実行してもファイルポインタの位置は変更されないため、
25    // 切り詰め後の内容を正確に読み込むために、通常は先頭に戻す必要があります。
26    $file->rewind();
27
28    // ファイルを特定のサイズに切り詰めます（truncate）。
29    // ここでは、ファイルを最初の20バイトに切り詰めます。
30    // ftruncate はバイト単位で動作します。
31    $truncateSize = 20; // 切り詰めるサイズ（バイト）
32    echo "--- 切り詰め操作 ---\n";
33    echo "ファイルを " . $truncateSize . " バイトに切り詰めます...\n";
34
35    // ftruncate メソッドは成功した場合に true、失敗した場合に false を返します。
36    if ($file->ftruncate($truncateSize)) {
37        echo "ファイルが正常に切り詰められました。\n\n";
38
39        // 切り詰め後の内容を確認するため、再度ファイルポインタを先頭に戻します。
40        $file->rewind();
41
42        // 切り詰め後のファイル内容を読み出して表示します。
43        $truncatedContent = '';
44        while (!$file->eof()) {
45            $truncatedContent .= $file->fread(8192); // ファイルの最後まで読み込みます
46        }
47        echo "--- 切り詰め後の状態 ---\n";
48        echo "切り詰め後の内容: " . $truncatedContent . "\n";
49        echo "最終ファイルサイズ: " . $file->fstat()['size'] . " バイト\n";
50    } else {
51        echo "エラー: ファイルの切り詰めに失敗しました。\n";
52    }
53}
54
55// 関数を実行して、ファイル切り詰め動作のデモンストレーションを行います。
56demonstrateSplTempFileObjectTruncation();

このPHPのサンプルコードは、SplTempFileObjectクラスを使って、一時ファイルの作成と内容の切り詰め（truncate）を行う方法をシステムエンジニアを目指す初心者向けに示しています。SplTempFileObjectは、プログラムの実行中に一時的なファイルを作成し、スクリプトの終了時に自動的に削除されるため、ファイルのテストや一時的なデータ処理に非常に適しています。

コードの中心となるのはftruncateメソッドです。このメソッドは、開いているファイルを引数$sizeで指定されたバイト数に切り詰めます。例えば、$sizeに20を指定すると、ファイルの先頭から20バイトだけが残り、それ以降のデータは削除されます。ftruncateメソッドは、処理が成功した場合は真偽値のtrueを、失敗した場合はfalseを戻り値として返しますので、切り詰め操作の成否をプログラムで確認できます。

サンプルでは、まずSplTempFileObjectに初期の内容を書き込み、そのサイズを表示します。次にftruncateメソッドを使ってファイルを20バイトに切り詰め、その結果と切り詰め後のファイル内容、最終的なファイルサイズを確認しています。ファイルを読み込む前には、rewind()メソッドでファイルポインタをファイルの先頭に戻すことが、正しく内容を読み出すために重要です。この一連の操作を通じて、ファイルの内容をバイト単位で調整する基本的なファイル操作の理解を深めることができます。

Copy
1<?php
2
3/**
4 * SplTempFileObject の ftruncate メソッドの使用例。
5 * ファイルを指定したサイズに切り詰めます。
6 */
7
8// SplTempFileObject のインスタンスを作成します。
9// これはメモリ上、またはシステムの一時ディレクトリに一時ファイルを作成します。
10$tempFile = new SplTempFileObject();
11
12// ファイルに初期コンテンツを書き込みます。
13$initialContent = "Hello, this is a test string to demonstrate ftruncate.";
14$tempFile->fwrite($initialContent);
15
16// ファイルポインタを先頭に移動させます。
17// この操作がないと、次の読み取りや書き込みがファイルの末尾から行われます。
18$tempFile->rewind();
19
20echo "初期コンテンツ: " . $tempFile->fread($tempFile->getSize()) . "\n";
21$tempFile->rewind(); // 再度先頭に戻す
22echo "初期ファイルサイズ: " . $tempFile->getSize() . " バイト\n\n";
23
24// ftruncate メソッドを使用してファイルを指定したサイズに切り詰めます。
25// ここではファイルを10バイトに切り詰めます。
26$newSize = 10;
27$result = $tempFile->ftruncate($newSize);
28
29if ($result) {
30    echo "ファイルを " . $newSize . " バイトに切り詰めることに成功しました。\n";
31
32    // ファイルポインタを再度先頭に移動させて、切り詰められた内容を読み込みます。
33    $tempFile->rewind();
34    $truncatedContent = $tempFile->fread($newSize); // 新しいサイズ分だけ読み込む
35
36    echo "切り詰め後のコンテンツ: " . $truncatedContent . "\n";
37    // 切り詰め後のファイルサイズを確認します。
38    echo "切り詰め後のファイルサイズ: " . $tempFile->getSize() . " バイト\n";
39} else {
40    echo "ファイルの切り詰めに失敗しました。\n";
41}
42
43// スクリプトの実行が終了すると、SplTempFileObject は自動的にクリーンアップ（削除）されます。
44
45?>

PHPのSplTempFileObject::ftruncateメソッドは、一時ファイルの内容を指定されたサイズに切り詰めるために使用されます。SplTempFileObjectは、メモリ上またはシステムの一時ディレクトリに作成される一時ファイルを効率的に扱うためのクラスです。

このサンプルコードでは、まずSplTempFileObjectのインスタンスを作成し、初期の文字列コンテンツを書き込んでいます。その後、ftruncateメソッドを呼び出し、引数$sizeに指定したバイト数（この例では10）までファイルを切り詰めます。$sizeは、ファイルを残したいバイト数を整数で指定し、その値より大きい部分は削除されます。メソッドが成功した場合はtrueを、失敗した場合はfalseを戻り値として返します。

切り詰め処理の前後では、ファイルポインタをrewind()メソッドでファイルの先頭に戻し、fread()で内容を読み取ることで、変更前後のコンテンツとファイルサイズを確認しています。これにより、ftruncateがどのように動作し、ファイルの内容とサイズが変化するかが明確にわかります。SplTempFileObjectは、スクリプトの実行が終了すると自動的にその一時ファイルを削除するため、手動でクリーンアップする必要がありません。