yriveiro/php-fslock

A simple lock implementation using flock.

FSLock

, _(*1)

A simple lock implementation using flock., _(*2)

NOTE: to use php-backoff with PHP 5.x please use the lastet release of branch 2.x, _(*3)

Usage

use FSLock\FSLock;

$lock = new FSLock('test');

if ($lock->acquire()) {
    // Critical code.

    $lock->release();
}

If you want to use a custom path to store the locks, you should instantiate the FSLock like that, _(*4)

$lock = new FSLock('test', '/tmp/');

API

• acquire: Acquires the lock, returns true if the operation was successful otherwise the return is false.
• release: Releases the lock, returns true if the operation was successful otherwise the return is false.
• id: returns the lock id.
• getPath: returns the lock path

Install

The recommended way to install this package is through Composer., _(*5)

composer require yriveiro/php-fslock:3.0.0

Tests

Tests are performed using the phpunit library, to run them:, _(*6)

php vendor/bin/phpunit tests

License

FSLock is licensed under MIT license., _(*7)