Laravel GDPR Exporter Documentation

A lightweight Livewire component for exporting user data in multiple GDPR-compliant formats.

Features

• Export authenticated user data in:
  • ✅ JSON
  • ✅ CSV
  • ✅ XML
  • ✅ HTML
• Automatically loads all Eloquent relations
• Filter out ID columns and other columns ending in _id or _by
• Streamed downloads
• Beautifully formatted output
• Built with Livewire 3
• Configurable relation detection (reflection or whitelist)
• Customizable export settings

Requirements

• PHP 8.2+
• Laravel 10+
• Livewire 3+

Installation

composer require milenmk/laravel-gdpr-exporter

1. Add the Livewire component in your Blade view:

   <livewire:gdpr-exporter />
   

2. Optional: Publish the configuration file:

   php artisan vendor:publish --tag=laravel-gdpr-exporter-config
   

3. Optional: Publish the Blade view if you want to customize the UI:

   php artisan vendor:publish --tag=laravel-gdpr-exporter-views
   

   This will publish the file in resources/views/vendor/laravel-gdpr-exporter/livewire/gdpr.blade.php

Export Formats

Configuration

The package provides several configuration options in config/gdpr-exporter.php:

User Model

Specify the user model class to use for GDPR exports:

'user_model' => env('GDPR_USER_MODEL', 'App\Models\User'),

Relations Detection

Choose between automatic reflection-based detection or explicit whitelist:

'relations_detection' => [
    'method' => env('GDPR_RELATIONS_METHOD', 'whitelist'), // 'reflection' or 'whitelist'
    
    // When using 'whitelist' method, only these relations will be loaded
    'whitelist' => [
        // Example: 'posts', 'profile', 'roles', 'permissions'
    ],
    
    // When using 'reflection' method, these methods will be excluded
    'excluded_methods' => [
        'delete', 'destroy', 'forceDelete', 'restore', 'save',
        // ... more methods listed in the config file
    ],
],

Export Settings

Configure how data is processed during export:

'export' => [
    // Whether to remove ID fields from the exported data
    'remove_ids' => env('GDPR_REMOVE_IDS', true),
    
    // Whether to flatten pivot table data in the export
    'flatten_pivot' => env('GDPR_FLATTEN_PIVOT', true),
],

How It Works

• Uses reflection to detect all Eloquent relationships on the User model.
• Loads relations and transforms the entire user structure to an array.
• Removes internal ID fields and flattens pivot data.
• Outputs the cleaned data in the selected format.

The user interface has a button to show the data in the browser and a dropdown, from whwre they can download the data in the selected format.

DISCLAIMER

This package is provided "as is" without warranty of any kind, either express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, or noninfringement.

The author(s) makes no representations or warranties regarding the accuracy, reliability or completeness of the code or its suitability for any specific use case. It is recommended that you thoroughly test this package in your environment before deploying it to production.

By using this package, you acknowledge and agree that the author(s) shall not be held liable for any damages, losses or other issues arising from the use of this software.

License

This package is licensed under the MIT License. See the LICENSE file for more details.