jeffersongoncalves / filament-quebec-retention
Filament admin for Quebec Law 25 retention: tombstones of destroyed or anonymized personal information, re-applied after a backup restore
Package info
github.com/jeffersongoncalves/filament-quebec-retention
pkg:composer/jeffersongoncalves/filament-quebec-retention
Requires
- php: ^8.2
- filament/filament: ^5.3
- jeffersongoncalves/filament-plugin-core: ^3.0
- jeffersongoncalves/laravel-quebec-retention: ^1.0
- spatie/laravel-package-tools: ^1.16
Requires (Dev)
- jeffersongoncalves/pest-plugin-database-migrations: ^1.0
- larastan/larastan: ^3.0
- laravel/pint: ^1.0
- orchestra/testbench: ^10.0|^11.0
- pestphp/pest: ^3.0|^4.0
- pestphp/pest-plugin-laravel: ^3.0|^4.0
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Filament Quebec Retention
The Filament panel for laravel-quebec-retention. Under Quebec's private sector privacy act (Law 25), personal information is destroyed or anonymized once the purposes for which it was collected are achieved (s. 23). This page lets you see what is due, run the retention, and erase again the data a restored backup brought back.
Features
- Preview: how many records would be anonymized now, per model and column. Nothing is changed.
- Apply retention: anonymizes every column whose period has ended, each with its own strategy.
- Re-apply after backup: anonymizes again the columns that a restored backup brought back.
- The list of anonymized columns (tombstones), filterable by model and column. Tombstones hold no personal information.
- 19 languages.
Compatibility
| Plugin Version | Filament |
|---|---|
| 1.x | 3.x |
| 2.x | 4.x |
| 3.x | 5.x |
Installation
You can install the package via composer:
composer require jeffersongoncalves/filament-quebec-retention:"^3.0" php artisan vendor:publish --tag="quebec-retention-migrations" php artisan migrate
Usage
use JeffersonGoncalves\Filament\QuebecRetention\QuebecRetentionPlugin; public function panel(Panel $panel): Panel { return $panel ->plugins([ QuebecRetentionPlugin::make() ->navigationGroup('Quebec') // default: no group ->navigationSort(30) ->navigationIcon('heroicon-o-clock') ->slug('data-retention'), ]); }
All fluent methods are optional. The buttons run in the web request: keep php artisan quebec:retention scheduled daily as the main way to apply retention, and use the panel to check and to act after a restore.
The resource has no authorization of its own: register it only on panels whose users may erase personal data, or add a policy for
JeffersonGoncalves\QuebecRetention\Models\Tombstone.
Related plugins
- filament-quebec: personal information inventory, with each column's retention.
- filament-quebec-consent: consent ledger.
- filament-quebec-requests: access, rectification, de-indexation and portability requests (ss. 27 to 32).
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.
