sajtiii/laravel-lockable-attributes

Lock your eloquent model attributes to prevent changes on them.

1.0.0 2024-11-06 14:42 UTC

Requires

• php: ^8.1
• laravel/framework: ^10.0||^11.0

Requires (Dev)

• filament/forms: ^3.2
• larastan/larastan: ^2.9
• laravel/pint: ^1.18
• orchestra/testbench: ^8.0||^9.0
• pestphp/pest: ^2.34
• pestphp/pest-plugin-arch: ^2.7
• pestphp/pest-plugin-laravel: ^2.3

MIT

• Attila Tamás Nagy

README

This package allows you to easily lock model attributes preventing them from a sudden override.

Usage

1. Setup database
   Add a json column to your database table named however you want, but preferably locked_attributes.

Schema::create('my_models', function (Blueprint $table) {
    ...
    $table->json('locked_attributes');
    ...
});

1. Prepare your model
   Add the HasLockedAttributes interface and InteractsWithLockedAttributes trait to your model:

use Sajtiii\LockableAttributes\Concerns\InteractsWithLockedAttributes;
use Sajtiii\LockableAttributes\Contracts\HasLockedAttributes;

class MyModel extends Model implements HasLockedAttributes
{
    use InteractsWithLockedAttributes;
    
    ...
}

1. Define which attributes can be locked.
   Add the getLockableAttributes() method to your model:

class MyModel extends Model implements HasLockedAttributes
{
    use InteractsWithLockedAttributes;
    
    public function getLockableAttributes(): array
    {
        return [
            'name',
            'title',
            ...
        ];
    }

Filament support

This package also comes with a form action for Filament, that can be added to form components allowing you to easily lock attributes on the resource page.

Limitations: This action currently can only be used on the view page of the resource.

Example (Adding the toggle action to a TextInput):

use Filament\Forms\Components\TextInput;
use Sajtiii\LockableAttributes\Contracts\HasLockedAttributes;
use Sajtiii\LockableAttributes\Filament\Forms\Actions\ToggleAttributeLockAction;

TextInput::make('name')
    ->suffixAction(ToggleAttributeLockAction::make('lock'))
    ->disabled(fn (?HasLockedAttributes $record) => $record && $record->isAttributeLocked($this->getStatePath(false))),