offline / oc-gdpr-plugin
October CMS plugin to make websites GDPR and ePrivacy compliant
Installs: 2 265
Dependents: 1
Suggesters: 0
Security: 0
Stars: 36
Watchers: 8
Forks: 20
Open Issues: 8
Language:HTML
Type:october-plugin
- dev-develop
- v2.2.29
- v2.2.28
- v2.2.27
- v2.2.26
- v2.2.25
- v2.2.24
- v2.2.23
- v2.2.22
- v2.2.21
- v2.2.20
- v2.2.19
- v2.2.18
- v2.2.17
- v2.2.16
- v2.2.15
- v2.2.14
- v2.2.13
- v2.2.12
- v2.2.11
- v2.2.10
- v2.2.9
- v2.2.8
- v2.2.7
- v2.2.6
- v2.2.5
- v2.2.4
- v2.2.3
- v2.2.2
- v2.2.1
- v2.2.0
- v2.1.1
- v2.1.0
- v2.0.19
- v2.0.17
- v2.0.16
- v2.0.15
- v2.0.14
- v2.0.13
- v2.0.12
- v2.0.11
- v2.0.10
- v2.0.9
- v2.0.8
- v2.0.7
- v2.0.6
- v2.0.4
- v2.0.3
- v2.0.2
- v2.0.1
- dev-master
- dev-separate-set-preferences-methode
This package is auto-updated.
Last update: 2024-12-05 15:46:50 UTC
README
October CMS plugin to make websites GDPR compliant.
This plugin is available on the October Marketplace: https://octobercms.com/plugin/offline-gdpr
Features
Cookie Consent Manager
This plugin provides two simple components to make your October installation GDPR compliant.
Quick start
- Define your cookie groups and cookies via the backend settings page.
You can also import a example preset by running
php artisan gdpr:import
- Place the
cookieManager
component on acookies.htm
page - Place the
cookieBanner
component on all of your layouts. Use the configuration listed below.
[cookieBanner] include_css = 1 update_partial = "gdpr" update_selector = "#gdpr-reload" cookie_manager_page = "cookies" == {% component 'cookieBanner' %}
- Create a new
gdpr.htm
partial. Include the partial in your layouts as shown below. Note the#gdpr-reload
wrapper.
<div id="gdpr-reload"> {% partial 'gdpr' %} </div>
- Inside your
gdpr.htm
partial you can now conditionally include your dependencies by querying the cookie'scode
.
{% if gdprCookieAllowed('google-analytics') %} <!-- Include analytics code here --> {% endif %}
Cookie manager
The cookieManager
component gives a visitor more control over the cookies your site is using.
This component can simply be placed on a page and needs no further configuration.
title = "Cookies" url = "/cookies" layout = "default" is_hidden = 0 [cookieManager] == {% component 'cookieManager' %}
Cookie presets
It is possible to define your cookie groups and cookies in a yaml
file and import them using the gdpr:import
console command.
This allows you to define cookies once and re-use them between installations.
php artisan gdpr:import --path=plugins/offline/gdpr/assets/presets/example_en.yaml --replace
You can find example definitions in the assets/presets
directory of this plugin.
You can optionally use the --replace
flag to remove all existing cookie data and replace it with your preset.
If no path is specified, the plugin will load all presets from the configured presets_path
and ask you which preset to import.
You can change the path where presets are loaded from by changing the offline.gdpr::config.presets_path
config entry.
To do this, create the file config/offline/gdpr/config.php
and return your custom path:
<?php return [ 'presets_path' => '/path/to/your/presets', ];
cookieBanner
The cookieBanner
component displays a cookie banner on the first page view. There the user has the possibility to
enable and disable cookies that your website uses (defined via October's backend settings).
These settings are stored and made available in your partials using the gdprCookieAllowed
helper. With this helper
you can check for the user's consent and optionally include your resources.
Installation
- Define your cookie groups and cookies via the Backend settings
- Add the
cookieBanner
component to all your layouts.
[cookieBanner]
include_css = 1
update_partial = "gdpr"
update_selector = "#gdpr-reload"
cookie_manager_page = "cookies"
==
{% component 'cookieBanner' %}
Log
You can enable a log via the backend settings so every cookie banner request gets logged. This is useful to get an idea of the number of users that do not accept a cookie request and therefore never end up in your analytics data.
The log only contains the user's session id and their decision.
Properties
If you don't want to include the default css use include_css = 0
when including your component.
cookieManager
page
Set the property cookie_manager_page
to the page that contains the cookieManager
component.
A Advanced Settings
link will be placed on the cookieBar
that links to this page. This enables the user to
further define what cookies are allowed.
Twig Helpers
gdprCookieAllowed($code, $minLevel = 0)
Check if a certain cookie is allowed to be included. You can optionally pass a cookie level to check if the user has accepted a specific level of this cookie.
{% if gdprCookieAllowed('google-analytics') %} <!-- Include Analytics Code here --> {% endif %} {% if gdprCookieAllowed('google-analytics', 3) %} <!-- Include advanced Level 3 Analytics Code here --> {% endif %}
gdprAllowedCookieLevel($code)
Get the max allowed level for a certain cookie. A return value of -1
means the cookie is not allowed at all. A
value of 0
or higher means the cookie is allowed with the returned level value.
{% if gdprAllowedCookieLevel('google-analytics') >= 3 %} <!-- Include advanced Level 3 Analytics Code here --> {% endif %}
gdprIsUndecided()
Check if the user has made a decision about the cookies yet. This will return true
on the second page view if the
user did not interact with the cookieBanner
(silent opt-in).
Data retention
The data retention functionality enables you to delete old plugin data after a specified amount of days.
You can specify the data retention policy for each plugin via October's backend settings.
Important: To automatically delete old data make sure you have set up the Task Scheduler correctly.
Register your plugin
To register your plugin you have to listen for the offline.gdpr::cleanup.register
event in your Plugin's boot method.
public function boot() { \Event::listen('offline.gdpr::cleanup.register', function () { return [ 'id' => 'your-contact-form-plugin', 'label' => 'Custom Contact Form Plugin', 'models' => [ [ 'label' => 'Contact form messages', 'comment' => 'Delete logged contact form messages', 'class' => MessageLog::class, ], [ 'id' => 'vendor-plugin-spam-messages', // The ID is required if you specify a closure. This should be unique to your plugin. 'label' => 'SPAM-Messages', 'comment' => 'Delete blocked SPAM messages', 'closure' => function (Carbon $deadline, int $keepDays) { // Delete your old data here }, ], ], ]; }); }
You have to specify the following data:
As models
you have to specify an array with the following data:
You have to specify either a closure
or a class
value. If both are specified the closure
value will be used.
Cleanup method
You can either specify a closure
or a model class that defines a gdprCleanup
method. Both have the same
signature:
public function gdprCleanup(\Carbon\Carbon $deadline, int $keepDays) { self::where('created_at', '<', $deadline)->each(function (self $item) { $item->delete(); }); // or // self::where('created_at', '<', $deadline)->delete(); }
This method is called whenever the cleanup job is run. $deadline
contains a Carbon
instance.
All data older than this date has to be deleted. $keepDays
contains the number of days
that $deadline
is in the past.
Make sure to use an each/delete
loop if your model makes use of deleting/deleted
model events.
Cleanup command
You can trigger the cleanup on demand via
php artisan gdpr:cleanup