jeffersongoncalves / filament-lgpd
Filament plugin for laravel-lgpd: a personal data inventory page (LGPD) listing every declared column with its category, purpose, legal basis, retention and anonymization.
Package info
github.com/jeffersongoncalves/filament-lgpd
pkg:composer/jeffersongoncalves/filament-lgpd
Requires
- php: ^8.2
- filament/filament: ^5.3
- jeffersongoncalves/filament-plugin-core: ^3.0
- jeffersongoncalves/laravel-lgpd: ^1.1
- spatie/laravel-package-tools: ^1.16
Requires (Dev)
- 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 LGPD
A personal data inventory page for your Filament panel, built on laravel-lgpd. It lists every column you declared with #[PersonalData], grouped by model, with its category, purpose, legal basis, retention and anonymization strategy. It is the starting point of the record of processing activities (ROPA, LGPD art. 37).
Features
- One card per model in
lgpd.models, one row per declared column. - Sensitive data (art. 5, II) highlighted.
- Columns without a legal basis flagged as "Not declared".
- English and Brazilian Portuguese.
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-lgpd:"^3.0"
Declare your personal data and register the models as described in laravel-lgpd.
Usage
use JeffersonGoncalves\Filament\Lgpd\LgpdPlugin; public function panel(Panel $panel): Panel { return $panel ->plugins([ LgpdPlugin::make() ->navigationGroup('LGPD') // default: no group ->navigationSort(1) ->navigationIcon('heroicon-o-finger-print') ->slug('personal-data-inventory'), ]); }
All fluent methods are optional. The page is read-only: the inventory lives in your code, next to the models.
The page has no authorization of its own: register it only on panels whose users may see it, or override
canAccess()in a subclass.
Related plugins
- filament-lgpd-dsar: data subject requests (art. 18).
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.
