ezsystems/privacy-cookie-bundle

Privacy cookie banner integration bundle into regular Symfony 2.x application (supports eZ Publish/eZ Platform)

Privacy Cookie Bundle

, _(*1)

This bundle adds privacy cookie banner into Symfony applications., _(*2)

, _(*3)

Requirements

• Symfony v2.6 or later (including Symfony 3.x)

Installation

This package is available via Composer, so the instructions below are similar to how you install any other open source Symfony Bundle., _(*4)

Run the following command in a terminal, from your Symfony installation root (pick most recent release):, _(*5)

php composer.phar require ezsystems/privacy-cookie-bundle

Enable the bundle in app/AppKernel.php file:, _(*6)

$bundles = array(
    // existing bundles
    new EzSystems\PrivacyCookieBundle\EzSystemsPrivacyCookieBundle(),
);

Add external assets to your bundle:, _(*7)

• CSS:

bundles/ezsystemsprivacycookie/css/privacycookie.css

• JS:

bundles/ezsystemsprivacycookie/js/privacycookie.js

Assetic (Optional)

Enable the Assetic bundle in app/AppKernel.php file:, _(*8)

$bundles = array( // ... // starting from Symfony 2.8 you have to enable AsseticBundle manually if you haven't done it before new Symfony\Bundle\AsseticBundle\AsseticBundle() );, _(*9)

Add the following minimal configuration in config.yml file to enable Assetic support in your application (Symfony 2.8 and later):, _(*10)

assetic:
    debug: '%kernel.debug%'
    use_controller: '%kernel.debug%'
    filters:
        cssrewrite: ~

If you are installing the bundle via composer require you must also copy assets to your project's web directory. You can do this by calling Symfony's built-in command from the project root directory:, _(*11)

For Symfony 2.x:, _(*12)

php app/console assets:install --symlink

For Symfony 3.x:, _(*13)

php bin/console assets:install --symlink

In production environment you have to dump assets using Assetic built-in command:, _(*14)

For Symfony 2.x:, _(*15)

php app/console assetic:dump -e=prod

For Symfony 3.x:, _(*16)

php bin/console assetic:dump -e=prod

Usage

Insert the following {{ show_privacy_cookie_banner(%privacy_policy_url%) }} helper somewhere in your footer template before the body ending tag. Replace the %privacy_policy_url% parameter with your policy page address., _(*17)

Note that the %privacy_policy_url% parameter is not required, in this case no policy link will be shown., _(*18)

The following optional parameters can be set as a second argument in an array format:, _(*19)

Example of usage in standard Symfony application:, _(*20)

{{ show_privacy_cookie_banner('http://ez.no/Privacy-policy') }}

or, _(*21)

{{ show_privacy_cookie_banner('http://ez.no/Privacy-policy', {
   cookieName: 'myCookie',
   cookieValidity: 7,
   cookiePath: '/',
   caption: 'Nice to see you here',
   learnMoreText: 'Find out more'
}) }}

If you are using eZ Publish / Platform you can use ez_urlalias to generate path for specified content object:, _(*22)

{{ show_privacy_cookie_banner(path('ez_urlalias', {contentId: 94}), {
   cookieName: 'myCookie',
   cookieValidity: 7,
   caption: 'Nice to see you here'
}) }}

Example of usage extraParams:, _(*23)

{{ show_privacy_cookie_banner('http://ez.no/Privacy-policy', {
   cookieName: 'myCookie',
   extraParams: {
       my_param1: value_my_param1 ,
       my_param2: value_my_param2
   }
}) }}