albertborsos / yii2-gdpr-cookie-consent

1.4.0 2026-10-18 16:53 UTC

Requires

• php: >=5.6.0
• 2amigos/yii2-switch-widget: ^1.0
• albertborsos/yii2-ddd: ~0.2
• bower-asset/cookieconsent: ~3.1
• yiisoft/yii2: ~2.0.0

Requires (Dev)

• codeception/codeception: ^2.4
• codeception/mockery-module: ^0.2.2
• codeception/specify: ~0.4.6
• codeception/verify: ~0.4.0
• mito/yii2-coding-standards: ~2.0.0@beta
• satooshi/php-coveralls: ~1.0

MIT

• Albert Borsos

• extension
• cookie
• yii2
• cookie policy
• gdpr
• cookie consent

Published on Packagist.org on 2026-10-18 16:53 UTC

README

GDPR compatible Cookie Consent widget allows the user to choose which kind of cookies they want to accept.

Installation

The preferred way to install this extension is through composer.

Run

composer require --prefer-dist albertborsos/yii2-gdpr-cookie-consent

Usage

add the component to your config file:

<?php
return [
    // ...
    'components' => [
        // ...
        'cookieConsent' => [
            'class' => \albertborsos\cookieconsent\Component::class,
            'urlSettings' => ['/site/cookie-settings'],
            'urlPrivacyPolicy' => ['/site/privacy-policy'],
            'documents' => [
                ['name' => 'Privacy Policy', 'url' => ['/docs/privacy-policy.pdf']],
            ],
            'disabledCategories' => [
                \albertborsos\cookieconsent\helpers\CookieHelper::CATEGORY_BEHAVIOR,
            ],
        ],
        // ...
        'i18n' => [
            // ...
            'translations' => [
                'cookieconsent/*' => [
                    'class' => 'yii\i18n\PhpMessageSource',
                    'basePath' => '@vendor/albertborsos/yii2-gdpr-cookie-consent/src/messages',
                ],
            ],
            // ...
        ],
    ],
    // ...
];

Register the widget in your layout. For example in a _cookieconsent.php partial view.

<?php
/** @var \albertborsos\cookieconsent\Component $component */
$component = Yii::$app->cookieConsent;
$component->registerWidget([
    'policyLink' => ['/default/cookie-settings'],
    'policyLinkText' => \yii\helpers\Html::tag('i', null, ['class' => 'fa fa-cog']) . ' Beállítások',
    'pluginOptions' => [
        'expiryDays' => 365,
        'hasTransition' => false,
        'revokeBtn' => '<div class="cc-revoke {{classes}}">Cookie Policy</div>',
    ],
]);

Add the cookie settings form to any of your controller:

<?php

namespace app\controllers;

class SiteController extends \yii\web\Controller
{
    public function actions()
    {
        return [
            'cookie-settings' => \albertborsos\cookieconsent\actions\CookieSettingsAction::class,
            'privacy-policy' => \albertborsos\cookieconsent\actions\PrivacyPolicyAction::class,
        ];
    }
}

Check your relevant widget is allowed by the user or not with the CookieConsent helper class in the following way:

<?php

use \albertborsos\cookieconsent\helpers\CookieHelper;
use \albertborsos\cookieconsent\Component;

if(CookieHelper::isAllowedType(CookieHelper::TYPE_GOOGLE_ANALYTICS)){
    // register GA script
}

if(CookieHelper::isAllowedCategory(CookieHelper::CATEGORY_BEHAVIOR)){
    // register hotjar script
}

Consent changes

The default onStatusChange and onRevokeChoice callbacks clear category overrides and reload the current page. This lets server-side checks such as CookieHelper::isAllowedType() apply the new consent immediately, including on landing pages.

Reloading can discard unsaved form values. Applications that manage their integrations without a reload can supply their own callbacks through pluginOptions. Custom callbacks remain responsible for clearing category overrides and applying consent changes.