blomstra / flarum-ext-gdpr

Gdpr extension for @flarum

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

GDPR or PII management

This extension allows users increasing control over their data.

Installation or update

Install manually with composer:

composer require blomstra/flarum-gdpr

Use

The user has a new button in their settings - account section called "Export Data". Upon clicking this button a modal will appear showing that user data can be exported. Once the export has been generated the user is notified through email with a unique, temporary link.

For developers

You can easily register a new Data type by implementing the Contract Blomstra\Gdpr\Contracts\DataType and then using the extender Blomstra\Gdpr\Extend\UserData:

<?php

use Blomstra\Gdpr\Extend\UserData;
use Your\Own\DataType;

return [
    new UserData(DataType::class)
];

The implementation you create needs a export method, it will receive a ZipArchive resource. You can use that to add any strings or actual files to the archive. Make sure to properly name the file and always prefix it with your extension slug (blomstra-something-filename).

Links

FAQ & Recommendations

  • Generating the zip archive can be pushed to queue functionality. This is exceptionally important on larger communities and with more extensions that work with the gdpr extension to allow data exports.

Links


About

Gdpr extension for @flarum

License:MIT License


Languages

Language:PHP 77.7%Language:TypeScript 17.3%Language:JavaScript 3.9%Language:Less 0.6%Language:Blade 0.5%