【PHP8.x】flockメソッドの使い方

flockメソッドは、SplFileObjectクラスが表すファイルに対して、ロックをかける処理を実行するメソッドです。これは、複数のプログラムやプロセスが同時に一つのファイルにアクセスし、データの書き込みや読み込みを行う際に、データの破壊や不整合を防ぐために非常に重要です。例えば、複数のユーザーが同時に同じ設定ファイルを更新しようとした場合、ファイルロックがないと一部の変更が失われたり、ファイルの内容が壊れてしまう可能性があります。

このメソッドでは、引数を通じてロックの種類を指定します。具体的には、他のプログラムからの読み込みは許可しつつ書き込みは禁止する「共有ロック」、他のどんなアクセスも一切許さない「排他ロック」、そして適用済みのロックを解除する操作などがあります。また、ロックがすぐに取得できない場合に、処理がロックの解放を待つかどうかを指定することも可能です。

flockメソッドは、指定されたロック操作が成功した場合はtrueを返し、失敗した場合はfalseを返します。これにより、ロックの取得状況に基づいて、プログラムの次の処理を適切に制御することができます。ファイル操作において安全性を確保するために、このメソッドはデータの整合性を保つ上で不可欠な機能を提供します。

Copy
1<?php
2$file = new SplFileObject('path/to/your/file.txt', 'w+');
3$operation = LOCK_EX; // LOCK_SH (共有ロック), LOCK_EX (排他ロック), LOCK_UN (ロック解除) のいずれか
4$wouldBlock = 0;      // オプション: ロック試行がブロックされた場合、非ゼロの整数が格納される
5
6$file->flock($operation, $wouldBlock);
7?>

int $operation, int &$would_block = null

• int $operation: 実行するロック操作を指定する整数。PHPのLOCK_SH、LOCK_EX、LOCK_UN、LOCK_NB定数を使用します。
• int &$would_block = null: オプション。ロックがすぐに取得できなかった場合に真偽値（true/false）が設定されます。

bool

ファイルロックの試みが成功した場合はtrueを、失敗した場合はfalseを返します。