LaravelPackages.net
Acme Inc.
Toggle sidebar
robertbaelde/laravel_read_only_fields

Protect read only fields from accidentally being updated

12.047
0
1.0.0
About robertbaelde/laravel_read_only_fields

robertbaelde/laravel_read_only_fields is a Laravel package for protect read only fields from accidentally being updated. It currently has 0 GitHub stars and 12.047 downloads on Packagist (latest version 1.0.0). Install it with composer require robertbaelde/laravel_read_only_fields. Discover more Laravel packages by robertbaelde or browse all Laravel packages to compare alternatives.

Last updated

Laravel read only fields

GitHub Tests Action Status

Laravel read only fields lets you guard fields against unexpected updates.

An example use case for this might be when a projector in an event sourced system updates a read model. You want to make sure that the read model only gets updated by the projector.

Guarding fields on a model

To guard fields use the HasReadOnlyFields trait in your model, and specify the read only fields by creating an array on your model named $readOnlyFields

use Illuminate\Database\Eloquent\Model;
use Temperworks\ReadOnlyFields\HasReadOnlyFields;

class YourModel extends Model
{
    use HasReadOnlyFields;

    protected array $readOnlyFields = [
        'read_only_field'
    ];
}

Updating read only fields

When you want to update a read only field, you can mark that you intend to update the field by using writable(['read_only_field']). After the model is saved, the writable state is reset.


$model = YourModel::find(1);
$model->writable(['read_only_field'])->update(['read_only_field' => 'foo']);

// this will throw an exception since we already updated the model. 
$model->update(['read_only_field' => 'foobar']);

Credits

License

The MIT License (MIT). Please see License File for more information.

Comments