Create a *.lock file, such as to lock down upgrades from running concurrently.

v0.1.3 2016-11-07 21:32 UTC

This package is not auto-updated.

Last update: 2021-02-26 04:28:25 UTC


This class is intended to avoid having multiple instances of a certain process (like an upgrade, such as with cs_webdbupgrade) from "tripping" over each other. Create a lock file somewhere on the system (which is readable + writable), and remove it when the operation completes. The file should stay if there's a problem that keeps the operation from completing (because trying again would probably fail, or would make things worse).

use crazedsanity\lockfile\LockFile;

$lock = new LockFile('/path/to/rw/dir', 'file.lock');

if(!$lock->is_lockfile_present()) {
	// ... do some stuff...
	// Only delete the lockfile if it all succeeded
else {
	throw new exception($lock->read_lockfile());

You may want to look at Web DB Upgrade for an implementation example.