A simple Laravel package that allows you to enforce immutable attributes on Eloquent models.
dylan-chapman/immutability is a Laravel package for a simple laravel package that allows you to enforce immutable attributes on eloquent models..
It currently has 0 GitHub stars and 8.907 downloads on Packagist (latest version 0.5).
Install it with composer require dylan-chapman/immutability.
Discover more Laravel packages by dylan-chapman
or browse all Laravel packages to compare alternatives.
Last updated
Immutability is a simple package that is used in your Eloquent models to enforce attribute immutability. Immutable attributes may be set, and changed once, but once the model is saved, the value can not be changed.
Immutability is open-sourced software licensed under the MIT license
To get started with Immutability, add to your composer.json file as a dependency:
composer require dylan-chapman/immutability
To use the Immutability library, you simply need to use the Immutability trait for any model you wish to identify immutable attributes for. Typically, you would want to implement the trait in your super-class so that all your sub-classes will automatically inherit the functionality.
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
use Eloquent\Attributes\Immutability;
class MyAppSuperModel extends Model
{
use Immutability;
protected $immutable = ['id', 'uuid'];
}
Class override.
<?php
namespace App;
class User extends MyAppSuperModel
{
protected $immutable = ['id', 'uuid', 'username'];
}
Catching exceptions
<?php
namespace App;
use Eloquent\Attributes\Exceptions\ImmutableFieldViolationException;
use Exception;
$user = User::find(1);
try {
$user->username = "myNewUserName";
$user->save();
} catch ( ImmutableFieldViolationException $e ) {
// Handle immutable attribute violation error
} catch ( Exception $e ) {
// Handle error
}
