https://github.com/sfolador/laravel-locked
Add locks to Eloquent models
https://github.com/sfolador/laravel-locked
eloquent laravel lock unlock
Last synced: 4 months ago
JSON representation
Add locks to Eloquent models
- Host: GitHub
- URL: https://github.com/sfolador/laravel-locked
- Owner: sfolador
- License: mit
- Created: 2022-11-12T08:31:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-30T11:27:53.000Z (12 months ago)
- Last Synced: 2024-05-02T01:26:19.894Z (12 months ago)
- Topics: eloquent, laravel, lock, unlock
- Language: PHP
- Homepage:
- Size: 89.8 KB
- Stars: 39
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Locked eloquent models
[](https://packagist.org/packages/sfolador/laravel-locked)
[](https://img.shields.io/github/actions/workflow/status/sfolador/laravel-locked/run-tests.yml?branch=main)
[](https://img.shields.io/github/actions/workflow/status/sfolador/laravel-locked/fix-php-code-style-issues.yml?branch=main)
[](https://packagist.org/packages/sfolador/laravel-locked)
A package to add locking features to Eloquent Models.
## Installation
You can install the package via composer:
```bash
composer require sfolador/laravel-locked
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="locked-config"
```
This is the contents of the published config file:
```php
return [
'locking_column' => 'locked_at',
'default_namespace' => 'App\Models',
'unlock_allowed' => true,
'can_be_unlocked' => [
],
'prevent_modifications_on_locked_objects' => false,
];
```
You can choose another default column name for the locking column by changing the `locking_column` value.
The `default_namespace` value is used to automatically add the namespace to the model passed as an argument to the Command. See the Usage section for more details.
The `unlock_allowed` value is used to enable or disable the `unlock` command. If you set it to `false`, the `unlock` method will raise an exception.
It's possible to add a _whitelist_ of models that can be unlocked by setting the `can_be_unlocked` array.
If the array is empty and the `unlock_allowed` value is `false`, no model can be unlocked.
The `prevent_modifications_on_locked_objects` value is used to forbid modifications on _locked_ models.
If you set it to `true`, an exception will be raised if you try to save/delete/replicated a _locked_ model.
## Command
There is an artisan command to create a migration for a class, run the command with :
```bash
php artisan lock-add {classname} {--namespace=}
```
For example, if you want to add a locking column to the `User` model, you can run the command :
```bash
php artisan lock-add User
```
This will create a migration file in the `database/migrations` folder, you can then run the migration with :
```bash
php artisan migrate
```
The command accepts an optional `--namespace` parameter, to specify the namespace of the class, for example :
```bash
php artisan lock-add User --namespace=App\Models\SomeFolder
```
The default namespace for the command is `App\Models` but you can change it in the config file by modifying the `default_namespace` value.
## Usage
Once created the migration, you can use the `Lockable` trait in your model.
```php
use Sfolador\Locked\Traits\HasLocks;
class User extends Model
{
use HasLocks;
}
```
this trait will add the following methods to your model :
- `lock()` : adds a lock to the model by setting the locking column to the current date
- `unlock()`: removes the lock by setting the locking column to null
- `isLocked()`: returns true if the model is locked, false otherwise
- `isUnlocked()`: returns true if the model is unlocked, false otherwise
- `isNotUnlocked()`: returns true if the model is not unlocked, false otherwise
- `isNotLocked()`: returns true if the model is not locked, false otherwise
- `toggleLock()`: toggles the lock state of the model
## Example
```php
$user = User::find(1);
$user->lock();
//...
if ($user->isNotLocked()) {
UserManager::update($user);
}
```
## Todo
- [x] Add an option to forbid locking a model if it is already locked and raise an Exception
- [x] Add an option to block notifications to the model if it is locked
- [ ] Add logging to locking/unlocking actions for auditing purposes
- [x] Add an option to block the model saving if it is locked
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Credits
- [sfolador](https://github.com/sfolador)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.