SplFileObject::flock
(PHP 5 >= 5.1.0, PHP 7, PHP 8)
SplFileObject::flock — Portable file locking
Description
public SplFileObject::flock(int
$operation, int &$wouldBlock = null): boolLocks or unlocks the file in the same portable way as flock().
Parameters
-
operation -
operationis one of the following:-
LOCK_SHto acquire a shared lock (reader). -
LOCK_EXto acquire an exclusive lock (writer). -
LOCK_UNto release a lock (shared or exclusive).
It is also possible to add
LOCK_NBas a bitmask to one of the above operations, if flock() should not block during the locking attempt. -
-
wouldBlock -
Set to
trueif the lock would block (EWOULDBLOCK errno condition).
Return Values
Returns true on success or false on failure.
Examples
Example #1 SplFileObject::flock() example
<?php
$file = new SplFileObject("/tmp/lock.txt", "w");
if ($file->flock(LOCK_EX)) { // do an exclusive lock
$file->ftruncate(0); // truncate file
$file->fwrite("Write something here\n");
$file->flock(LOCK_UN); // release the lock
} else {
echo "Couldn't get the lock!";
}
?>
Here you can write a comment
There are no comments available yet.
