【PHP8.x】ftruncate関数の使い方
作成日: 更新日:
ftruncate関数は、開いているファイルを指定した長さに切り詰める、または拡張するために使用される関数です。この関数は、主にファイルの内容を特定のサイズに調整したい場合に役立ちます。
ftruncate関数は二つの引数を取ります。一つ目は、fopen()などで開かれたファイルのポインタ（ファイルリソース）です。二つ目は、ファイルを変更したい新しいバイト単位のサイズを指定する整数値です。
もし指定されたサイズが現在のファイルサイズよりも小さい場合、ファイルはそのサイズまで切り詰められ、指定サイズを超えた部分のデータは完全に削除されます。一方、指定されたサイズが現在のファイルサイズよりも大きい場合、ファイルはその新しいサイズまで拡張されます。この際、元のファイルサイズから新しいサイズまでの追加された部分は、通常、ヌル文字（\0）で埋められます。ファイルポインタの位置は、この関数の実行によって変更されることはありません。
ftruncate関数は、操作が成功した場合はtrueを、失敗した場合はfalseを返します。例えば、ログファイルのサイズが無限に増えるのを防ぎたい場合や、一時ファイルを特定のサイズに初期化したい場合などにこの関数を使用できます。ファイルへの書き込み権限が必要です。
基本的な使い方
構文(syntax)
ftruncate($file_handle, $size_in_bytes);
引数(parameters)
resource $stream, int $size
- resource $stream: ファイルポインタまたはストリームリソース
- int $size: ファイルを切り詰めるバイト単位のサイズ
戻り値(return)
bool
指定されたファイルポインタの位置までファイルサイズを切り詰めます。成功した場合は true を、失敗した場合は false を返します。