balazscsaba2006/cookiebot

CookieBot integration into Craft CMS 3.

2.1.2 2022-10-05 12:51 UTC

This package is auto-updated.

Last update: 2022-10-05 12:52:12 UTC


README

CookieBot integration into Craft CMS 3 or 4.

Requirements

This plugin requires Craft CMS 3.0.0 or later.

Install

  • Install with Composer via: composer require balazscsaba2006/cookiebot
  • Navigate to Settings -> Plugins and click the "Install" button

Configure

  • Navigate to Settings -> Plugins and configure settings for Cookiebot

Overriding plugin settings

If you create a config file in your config/ folder called cookiebot.php, you can override the plugin’s settings in the Control Panel. Since that config file is fully multi-environment aware, this is a handy way to have different settings across multiple environments.

Here’s what that config file might look like along with a list of all of the possible values you can override.

    <?php

    return [
        'domainGroupID' => 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
        'defaultPreferences' => true,
        'defaultStatistics' => true,
        'defaultMarketing' => false
    ];

Usage

Can be used to render dialog and declaration script on Twig templates

Render dialog script:

{{ craft.cookiebot.dialogScript()|raw }}

Render declaration script:

{{ craft.cookiebot.declarationScript()|raw }}

Render dialog/declaration script in a certain language:

{# dialog script #}
{{ craft.cookiebot.dialogScript(craft.app.locale.id)|raw }}

{# declaration script #}
{{ craft.cookiebot.declarationScript(craft.app.locale.id)|raw }}

Can be used to check for consent on certain cookie categories like: Preferences, Statistics and Marketing.

Checking for any consent:

{% if craft.cookiebot.hasConsent %}
    {# ... #}
{% endif %}

Checking for consent on a specific category:

Preferences:

{% if craft.cookiebot.hasPreferencesConsent %}
    {# ... #}
{% endif %}

Statistics:

{% if craft.cookiebot.hasStatisticsConsent %}
    {# ... #}
{% endif %}

Marketing:

{% if craft.cookiebot.hasMarketingConsent %}
    {# ... #}
{% endif %}