README

This package stores selected attributes of Models before deletion.

Why?

If a user requests a deletion of their user data, you are partially required to remove all data related to the user (GDPR). With this package, you can store certain attributes & values e.g. to block previously registered usernames oder email addresses.

Installation

composer require romanzipp/laravel-previously-deleted

If you use Laravel 5.5+ you are already done, otherwise continue:

romanzipp\PreviouslyDeleted\Providers\PreviouslyDeletedProvider::class,

Add Service Provider to your app.php configuration file:

Configuration

Copy configuration to config folder:

$ php artisan vendor:publish --provider="romanzipp\PreviouslyDeleted\Providers\PreviouslyDeletedProvider"

Run the migration:

$ php artisan migrate

Usage

This example shows the usage with a User model and stored "username" and "email" attributes.

Add Model Trait

use romanzipp\PreviouslyDeleted\Traits\SavePreviouslyDeleted;

class User extends Model
{
    use SavePreviouslyDeleted;

    protected $storeDeleted = [
        'username',
        'email',
    ];
}

Add Validation Rule

The validation rule takes 2 arguments: not_deleted:{table}[,{attribute}]

table: The queried table name. In this exmaple: users.
attribute: The model attribute. If not given, the input name will be used.

public function store(Request $request)
{
    $request->validate([
        'name' => ['required', 'not_deleted:users,username'],
        'email' => ['required', 'not_deleted:users'],
        'password' => ['required', 'min:6']
    ]);

    User::create([
        'username' => $request->input('name'),
        'email' => $request->input('email'),
        'password' => bcrypt($request->input('password')),
    ]);
}

You can also use a rule instance:

use romanzipp\PreviouslyDeleted\Rules\NotPreviouslyDeleted;

$request->validate([
    'name' => ['required', new NotPreviouslyDeleted(User::class, 'username')],
    'email' => ['required', new NotPreviouslyDeleted(User::class)],
    'password' => ['required', 'min:6']
]);

Extended Usage

Storing hashed values

When storing personal information you should create hashes to respect your users privacy.

Store plain-text values

protected $storeDeleted = [
    'username',
    'email',
];

With the GDPR (DSGVO) a user has the right to request a full deletion of all personal information, including email address, username etc. If you're affected by this, you should make use of hashing algorythms to prevent any harm of privacy.

Store hashed values

protected $storeDeleted = [
    'username' => 'sha1',
    'email' => 'md5',
];

Storing soft deletes

By default, the package only stores attributes if the model is being force-deleted.

To enable storing attributes even in soft-deletion, set the ignore_soft_deleted config value to false.

return [
    'ignore_soft_deleted' => false,
];

Testing

./vendor/bin/phpunit

romanzipp / laravel-previously-deleted

Maintainers

Details