LoopRun Barcelona 2020

SplFileObject::flock

(PHP 5 >= 5.1.0, PHP 7)

SplFileObject::flock簡易なファイルロックを行う

説明

public SplFileObject::flock ( int $operation [, int &$wouldblock ] ) : bool

flock() と同じ簡易な方法でファイルをロックもしくはロック解除する。

パラメータ

operation

operation は次のいずれかです:

  • 共有ロック (読み手) にするには LOCK_SH
  • 排他ロック (書き手) にするには LOCK_EX
  • (共有もしくは排他) ロックを解除するには LOCK_UN
  • ロック中にブロックしないようにするには LOCK_NB

wouldblock

ロックがブロックされる場合 (errno が EWOULDBLOCK である)、TRUE にセットします。

返り値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

例1 SplFileObject::flock() の例

<?php
$file 
= new SplFileObject("/tmp/lock.txt""w");
if (
$file->flock(LOCK_EX)) { // 排他ロックを行う
    
$file->ftruncate(0);     // ファイルを丸める
    
$file->fwrite("ここで何かを書き出します\n");
    
$file->flock(LOCK_UN);   // ロックを解除する    
} else {
    echo 
"ロックを取得できませんでした!";
}
?>

変更履歴

バージョン 説明
5.5.22, 5.6.6 Windows 上で wouldblock パラメータがサポートされました。
5.3.2 ファイルのリソースハンドルが閉じられたときに、自動でアンロックする機能は削除されました。 アンロックは常に手動で行わなければならなくなりました。

参考

  • flock() - 汎用のファイルロックを行う

add a note add a note

User Contributed Notes 1 note

up
2
digitalprecision at gmail dot com
9 years ago
For the record, the example given here has an explicit command to truncate the file, however with a 'write mode' of 'w', it will do this for you automatically, so the truncate call is not needed.
To Top