cerpus / gdpr
A package that helps with implementing GDPR compliance in the EdLib ecosystem
Installs: 234
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Type:project
Requires
- php: >=7.0
- cerpus/laravel-auth: *
- illuminate/bus: >=5.2
- illuminate/database: >=5.2
- illuminate/http: >=5.2
- illuminate/pagination: >=5.2
- illuminate/queue: >=5.2
- illuminate/routing: >=5.2
- illuminate/support: >=5.2
- league/fractal: >=0.13
- nesbot/carbon: ^1.0||^2.0
- ramsey/uuid: >=3.8
Requires (Dev)
- fzaninotto/faker: ^1.8
- mockery/mockery: ^1.2
- orchestra/database: ^3.5
- orchestra/testbench: ^3.5
- phpunit/phpunit: ^6.5
README
#GDPR helper service This is a Laravel package to help implement GDPR compliance in a system
Installation
composer require cerpus/gdpr
If you are running on Laravel 5.4 or less you must add the service provider to config/app.php
.
'providers' => [ ... Cerpus\Gdpr\GdprServiceProvider::class, ];
In Laravel 5.5 and up the package will auto register.
Publish artifacts to your app.
php artisan vendor:publish --provider="Cerpus\Gdpr\GdprServiceProvider"
This will publish the config file to config/gdpr.php
. The GdprService will have a default deletion file, and you have to make a class that implements the Cerpus\Gdpr\Contracts\GdprDeletionContract
interface. Change the config/gdpr.php
file to point to your implementation.
<?php return [ 'deletion-class' => Cerpus\Gdpr\DummyDeletion::class, ... ];
php artisan migrate
to run the published migration(s).
Usage
To implement the GDPR deletion in your system create a class somewhere in your app that implements the Cerpus\Gdpr\Contracts\GdprDeletionContract
.
See src/DummyDeletion.php
for the default example. You can copy this and rename it to start you deletion class.
As an example if you create a file in app/Gdpr/GdprDelete.php
you must update the config/gdpr.php
like this:
return [ 'deletion-class' => App\Gdpr\GdprDelete::class, ... ];
The delete
method will receive a GdprDeletionRequest
as parameter. The request itself is in $deletionRequest->payload and will at least include an AuthId (userId).
You should log the progress of the deletion using $deletionRequest->log('processing', <your message here>);
at appropriate times.
License
This package is released under the GNU General Public License 3.0. See the
LICENSE
file for more information.