SplFileObject::flock
(PHP 5 >= 5.1.0, PHP 7)
SplFileObject::flock — Portable file locking
Description
$operation
[, int &$wouldblock
] ) : boolLocks or unlocks the file in the same portable way as flock().
Parameters
-
operation
-
operation
is one of the following:-
LOCK_SH
to acquire a shared lock (reader). -
LOCK_EX
to acquire an exclusive lock (writer). -
LOCK_UN
to release a lock (shared or exclusive). -
LOCK_NB
to not block while locking.
-
-
wouldblock
-
Set to
TRUE
if the lock would block (EWOULDBLOCK errno condition).
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!";
}
?>
Changelog
Version | Description |
---|---|
5.5.22, 5.6.6 |
Added support for the wouldblock parameter on
Windows.
|
5.3.2 | The automatic unlocking when the file's resource handle is closed was removed. Unlocking now always has to be done manually. |
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-splfileobject.flock.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.