alt-three/locker

A lock manager for Laravel

v6.3.0 2019-12-28 09:37 UTC

README

Alt Three Locker

StyleCI Status Build Status Software License Latest Version

Installation

Alt Three Locker is a lock manager for Laravel. This version requires PHP 7.1-7.4, and supports Laravel 5.5-7. Simply require the package using Composer:

$ composer require alt-three/locker

Once installed, if you are not using automatic package discovery, then you need to register the AltThree\Locker\LockerServiceProvider service provider in your config/app.php.

Configuration

Alt Three Locker requires configuration.

To get started, you'll need to publish all vendor assets:

$ php artisan vendor:publish

This will create a config/locker.php file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.

Usage

Alt Three Locker provides a locker class which should be used to execute critical tasks while acquiring a lock to do so. We also have a locker middleware which will acquire a lock on a per session basis to perform "unsafe" tasks, or in other words, we're preventing more than one non-GET request from being processed at once per user.

Security

Our full security policy is available to read here.

License

Alt Three Locker is licensed under The MIT License (MIT).