mustangx/eu-cookie-law-bundle

This package is abandoned and no longer maintained. No replacement package was suggested.

Eu Cookie Law Bundle to handle new privacy law

1.0.1 2017-06-18 18:09 UTC

MIT

README

NOTE: This bundle is a copy of XsolveCookieAcknowledgementBundle. It has been forked into our own project because of some small differences needed for the MustangX Project. We are building on Symfony3+, so this may work on other Symfony projects.

This bundle provides information about cookies usage, which is forced by European Union by so-called EU cookie law.

It includes:

• fast & easy integration and short learning curve
• automatic cookie bar injection on the bottom of the page
• ability to manually inject cookie bar (for example for iframes)
• ability to change text and "close button" name
• locale aware
• ability to provide own cookie bar template

This bundle requires Multibyte String extension.

Installation

Symfony 4

This needs to be preinstalled

 composer require templating

and then add it to config/packages/framework.yaml

 framework:
    //...

    templating:
        engines: ['twig']

Symfony 3 & 4

1) Install with composer

composer require mustangx/eu-cookie-law-bundle

Symfony 3

2) Run the bundle in app/AppKernel.php

    public function registerBundles()
    {
        return array(
            // ...
            new Eu\CookieLawBundle\EuCookieLawBundle(),
        );
    }

Symfony 4

2) Run the bundle in `config/bundles.php`

return [
    //...
    Eu\CookieLawBundle\EuCookieLawBundle::class => ['all' => true],
];

Usage

For all static pages

By default the cookie bar will be visible on every page after turning on bundle.

For iframes

Disable response injection in app/config/config.yml

eu_cookie_law:
    response_injection: false

Include cookie bar in appropriate location

{% include 'EuCookieLawBundle::cookie_law_bar.html.twig' %}

Configuration options

Configuration can be adjusted in app/config/config.yml

eu_cookie_law:
    response_injection: true # default true
    template: custom_cookie_bar.html.twig # twig template name, default: EuCookieLawBundle::cookie_law_bar.html.twig

Altering cookie bar texts

Place tranlations file in your app directory:

app/Resources/translations/EuCookieLawBundle.en.yml

And change texts

cookie.message: My message
cookie.message.accept: Accept button text

Of course you can set up those texts in as many locales as you want.

Altering cookie bar apperance

By default cookie bar comes with some default styles. If you wish to change those, use CSS. For example you may want pink background with placement on top of the page:

#cookie-law-info-bar {
    background: pink !important;
    top: 50px !important;
    bottom: auto !important;
}

Please note that every style needs `!important` to override provided inline styles.

Altering whole cookie bar template

You use your own template by setting it in the configuration (app/config/config.yml):

xsolve_cookie_acknowledgement:
    template: ::custom_cookie_bar.html.twig

In above case template is located in app/Resources/custom_cookie_bar.html.twig

Also base template can be reused be Twig extension (two blocks are used: xsolve_cookie_message and xsolve_cookie_message_js), see example below:

{% extends "EuCookieLawBundle::cookie_law_bar.html.twig" %}

{% block xsolve_cookie_message %}
    {{ parent() }}
    <div>This is something custom</div>
{% endblock %}

{% block xsolve_cookie_message_js %}
    {{ parent() }}
    <script type="text/javascript">
        document.getElementById('js-cookie-law-close-button').onclick = function () {
            alert('Got ya!');
        }
    </script>
{% endblock %}

Automated testing

There are fe simple test to make sure that everything works fine. To run tests include this bundle into some Symfony3 project (Symfony Standard Edition is enough). Then put testsuite in app/phpunit.xml

<testsuite name="EU Cookie Law Bundle Suite">
    <directory>../vendor/mustangx/eu-cookie-law-bundle/EU/CookieLawBundle/Tests/</directory>
</testsuite>

And run

phpunit -c app/