nucleos/gdpr-bundle

This bundle provides a GDPR conform cookie information for symfony applications.

2.8.0 2024-08-14 16:25 UTC

Requires

• php: ^8.1
• sonata-project/block-bundle: ^4.21 || ^5.0
• sonata-project/form-extensions: ^1.19 || ^2.0
• symfony/dependency-injection: ^6.4 || ^7.0
• symfony/event-dispatcher: ^6.4 || ^7.0
• symfony/expression-language: ^6.4 || ^7.0
• symfony/framework-bundle: ^6.4 || ^7.0
• symfony/http-foundation: ^6.4 || ^7.0
• symfony/http-kernel: ^6.4 || ^7.0
• symfony/options-resolver: ^6.4 || ^7.0
• symfony/twig-bundle: ^6.4 || ^7.0

Requires (Dev)

• ergebnis/composer-normalize: ^2.0.1
• symfony/browser-kit: ^6.4 || ^7.0
• symfony/console: ^6.4 || ^7.0
• symfony/yaml: ^6.4 || ^7.0

Suggests

• nucleos/shariff-bundle: If you need a GDPR conform social media widget integration

MIT

• Christian Gripp

• symfony
• sonata
• bundle
• block
• cookie
• widget
• privacy
• gdpr
• dsgvo
• sonata-block
• FLoC

README

This bundle provides a GDPR conform cookie information for symfony applications.

Installation

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

composer require nucleos/gdpr-bundle

Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in config/bundles.php file of your project:

// config/bundles.php

return [
    // ...
    Nucleos\NucleosGDPRBundle\NucleosGDPRBundle::class => ['all' => true],
];

Block cookies

By default all cookies are kept, also the cookie consent was not set. To block all domain cookies, you can set the following config.

# config/packages/nucleos_gdpr.yaml

nucleos_gdpr:
    block_cookies: null

You can define a list of cookies that are kept:

# config/packages/nucleos_gdpr.yaml

nucleos_gdpr:
    block_cookies:
        keep:
          - PHPSESSID
          - ADMIN_.*

Google FLoC (Federated Learning of Cohorts)

By default a Permissions-Policy header is added to every response to respect user privacy. You can enable Google FLoC tracking via the following configuration:

# config/packages/nucleos_gdpr.yaml

nucleos_gdpr:
    privacy:
        google_floc: true

Assets

It is recommended to use webpack / webpack-encore to include the GdprPopup.js and GdprPopup.css file in your page. These files are located in the assets folder.

Usage

{# template.twig #}

{{ sonata_block_render({ 'type': 'nucleos_gdpr.block.information' }, {
    'url': 'https://example.com/gdpr',
    'text': 'Example text' // optional
}) }}

License

This bundle is under the MIT license.