PHPackages                             amiralii/laravel-redlock - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. amiralii/laravel-redlock

ActiveLibrary[Utility & Helpers](/categories/utility)

amiralii/laravel-redlock
========================

Redis distributed locks for laravel

4.0.2(5y ago)018MITPHPPHP ^7.1.3CI failing

Since Dec 14Pushed 5y agoCompare

[ Source](https://github.com/amiralii/laravel-redlock)[ Packagist](https://packagist.org/packages/amiralii/laravel-redlock)[ RSS](/packages/amiralii-laravel-redlock/feed)WikiDiscussions master Synced yesterday

READMEChangelog (4)Dependencies (6)Versions (17)Used By (0)

Laravel RedLock
===============

[](#laravel-redlock)

Provides a generic locking mechanism using Redis. Implements the locking standard proposed by Redis.

### Acknowledgements

[](#acknowledgements)

This library was originally built by LibiChai based on the Redlock algorithm developed by antirez. The library was reworked by the team at That's Us, Inc.

### Installation

[](#installation)

1. `"parsadp/laravel-redlock": "^4.0.0"`
2. `"composer update"`
3. Add `Amiralii\RedLock\RedLockServiceProvider::class,` to the `providers` array in config/app.php
4. Enjoy!

### It's Simple!

[](#its-simple)

Set a lock on any scalar. If the `lock()` method returns false, you did not acquire the lock.

Store results of the `lock()` method. Use this value to release the lock with `unlock()`.

### Example

[](#example)

This example sets a lock on the key "1" with a 3 second expiration time.

If it acquired the lock, it does some work and releases the lock.

```
 use Amiralii\RedLock\Facades\RedLock;

 $product_id = 1;

 $lock_token = RedLock::lock($product_id, 3000);

 if ($lock_token) {

     $order->submit($product_id);

     RedLock::unlock($lock_token);
 }
```

### Refresh

[](#refresh)

Use `refreshLock()` to reacquire and extend the time of your lock.

```
 use Amiralii\RedLock\Facades\RedLock;

 $product_ids = [1, 2, 3, 5, 7];

 $lock_token = RedLock::lock('order-submitter', 3000);

 while ($product_ids && $lock_token) {

     $order->submit(array_shift($product_ids));

     $lock_token = RedLock::refreshLock($lock_token);
 }

 RedLock::unlock($lock_token);
```

### Even Easier with Closures

[](#even-easier-with-closures)

Use `runLocked()` for nicer syntax. The method returns the results of the closure, or else false if the lock could not be acquired.

```
 use Amiralii\RedLock\Facades\RedLock;

 $product_id = 1;

 $result = RedLock::runLocked($product_id, 3000, function () use ($order, $product_id) {
     $order->submit($product_id);
     return true;
 });

 echo $result ? 'Worked!' : 'Lock not acquired.';
```

### Refresh with Closures

[](#refresh-with-closures)

You can easily refresh your tokens when using closures. The first parameter to your closure is `$refresh`. Simply call it when you want to refresh. If the lock cannot be refreshed, `$refresh()` will break out of the closure.

```
 use Amiralii\RedLock\Facades\RedLock;

 $product_ids = [1, 2, 3, 5, 7];

 $result = RedLock::runLocked($product_id, 3000, function ($refresh) use ($order, $product_ids) {
     foreach ($product_ids as $product_id) {
         $refresh();
         $order->submit($product_id);
     }
     return true;
 });

 echo $result ? 'Worked!' : 'Lock lost or never acquired.';
```

### Lock Queue Jobs Easily

[](#lock-queue-jobs-easily)

If you're running jobs on a Laravel queue, you may want to avoid queuing up the same job more than once at a time.

The `Amiralii\RedLock\Traits\QueueWithoutOverlap` trait provides this functionality with very few changes to your job. Usually only two changes are necessary.

1. `use Amiralii\RedLock\Traits\QueueWithoutOverlap` as a trait
2. Change the `handle()` method to `handleSync()`

```
use Amiralii\RedLock\Traits\QueueWithoutOverlap;

class OrderProductJob
{
    use QueueWithoutOverlap;

    public function __construct($order, $product_id)
    {
        $this->order = $order;
        $this->product_id = $product_id;
    }

    public function handleSync()
    {
        $this->order->submit($this->product_id);
    }

}
```

Sometimes it's also necessary to specify a `getLockKey()` method. This method must return the string that needs to be locked.

This is typically unnecessary because the lock key can be generated automatically. But if the job's data is not easy to stringify, you must define the `getLockKey()` method.

This trait also provides a refresh method called `refreshLock()`. If `refreshLock()` is unable to refresh the lock, an exception is thrown and the job fails.

Finally, you can change the lock time-to-live from the default 300 seconds to another value using the `$lock_time` property.

```
use Amiralii\RedLock\Traits\QueueWithoutOverlap;

class OrderProductsJob
{
    use QueueWithoutOverlap;

    protected $lock_time = 600; // 10 minutes in seconds

    public function __construct($order, array $product_ids)
    {
        $this->order = $order;
        $this->product_ids = $product_ids;
    }

    // We need to define getLockKey() because $product_ids is an array and the
    // automatic key generator can't deal with arrays.
    protected function getLockKey()
    {
        $product_ids = implode(',', $this->product_ids);
        return "OrderProductsJob:{$this->order->id}:{$product_ids}";
    }

    public function handleSync()
    {
        foreach ($this->product_ids as $product_id) {
            $this->refreshLock();
            $this->order->submit($product_id);
        }
    }

}
```

### Contribution

[](#contribution)

If you find a bug or want to contribute to the code or documentation, you can help by submitting an [issue](https://github.com/amiralii/laravel-redlock/issues) or a [pull request](https://github.com/amiralii/laravel-redlock/pulls).

### License

[](#license)

[MIT](http://opensource.org/licenses/MIT)

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity66

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~127 days

Recently: every ~245 days

Total

12

Last Release

2040d ago

Major Versions

1.0.2 → v3.0.12017-05-30

v3.0.5 → 4.0.02020-10-10

2.0.0 → 4.0.12020-10-10

PHP version history (2 changes)1.0.0PHP >=5.4.0

4.0.0PHP ^7.1.3

### Community

Maintainers

![](https://www.gravatar.com/avatar/ac12ee0ba1d7a966fb9eb835f8bf79523db3737217b7f2a26e4c49558335c8ea?d=identicon)[amiralii](/maintainers/amiralii)

---

Top Contributors

[![dankuck](https://avatars.githubusercontent.com/u/277837?v=4)](https://github.com/dankuck "dankuck (21 commits)")[![libi](https://avatars.githubusercontent.com/u/7769922?v=4)](https://github.com/libi "libi (11 commits)")[![bitcodr](https://avatars.githubusercontent.com/u/10177380?v=4)](https://github.com/bitcodr "bitcodr (9 commits)")[![BrandonShar](https://avatars.githubusercontent.com/u/6599653?v=4)](https://github.com/BrandonShar "BrandonShar (2 commits)")[![evanBurg](https://avatars.githubusercontent.com/u/4584403?v=4)](https://github.com/evanBurg "evanBurg (1 commits)")[![potsky](https://avatars.githubusercontent.com/u/408237?v=4)](https://github.com/potsky "potsky (1 commits)")

---

Tags

laravellaravel56phpphp71redlockredlock-redisredlocklaravel redis lockredis lock

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/amiralii-laravel-redlock/health.svg)

```
[![Health](https://phpackages.com/badges/amiralii-laravel-redlock/health.svg)](https://phpackages.com/packages/amiralii-laravel-redlock)
```

###  Alternatives

[barryvdh/laravel-ide-helper

Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion.

14.9k123.0M687](/packages/barryvdh-laravel-ide-helper)[wnx/laravel-stats

Get insights about your Laravel Project

1.8k1.8M7](/packages/wnx-laravel-stats)[orchestra/canvas

Code Generators for Laravel Applications and Packages

21017.2M158](/packages/orchestra-canvas)[thatsus/laravel-redlock

Redis distributed locks for laravel

53145.2k](/packages/thatsus-laravel-redlock)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

245.2k](/packages/aedart-athenaeum)[interaction-design-foundation/laravel-geoip

Support for multiple Geographical Location services.

17221.0k3](/packages/interaction-design-foundation-laravel-geoip)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)