README

Symfony 3 Cookie Consent bundle

安装

步骤 1: 安装组件包

安装组件包最简单的方法是使用composer。

$ composer require fairlane/cookie-consent-bundle"

此命令要求您全局安装Composer，如Composer文档中的安装章节中所述。

步骤 2: 启用组件包

然后，将组件包添加到项目中app/AppKernel.php文件中注册的组件包列表中，以启用该组件包

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new Fairlane\CookieConsentBundle\FairlaneCookieConsentBundle(),
        );

        // ...
    }

    // ...
}

步骤 3: 配置组件包

此组件包有一些简单的配置。要查看配置选项列表，请运行以下命令

$ bin/console config:dump-reference fairlane_cookie_consent

您必须全局公开fairlane_cookie_consent.twig服务。

twig:
    // ...
    globals:
      // ...
      fairlane_cookie_consent: '@fairlane_cookie_consent.twig'

您的配置应该看起来像这样。

# Fairlane Cookie Consent configuration
fairlane_cookie_consent:
    active: true
    use_bootstrap: true
    use_jquery: true
    translate: false
    cookie_lifetime: 365 # days
    twig:
        text_info: 'This site uses cookies for...'
        text_accept_button: 'OK'
        text_additional_info_link: 'Read more about our cookie policy from here'
        url_additional_info: 'https://yourdomain/your-cookie-policy'

twig:
    globals:
      fairlane_cookie_consent: '@fairlane_cookie_consent.twig'

还必须导入路由。将以下路由添加到您的routes.yml

fairlane_cookie_consent:
    resource: "@FairlaneCookieConsentBundle/Resources/config/routing.yml"

最后，将twig模板包含到您的布局文件中。

{{ include('FairlaneCookieConsentBundle::cookie-info.html.twig') }}

步骤 4: 样式化cookie通知

div的id为fairlane-cookie-consent。您可以根据需要对其进行样式化。如果将use_bootsrap设置为true，则扩展会将navbar navbar-fixed-top类添加到div，并将btn btn-primary类添加到按钮。

如果将use_jquery设置为true，则通过ajax调用发送cookie的接受。否则，您需要自行处理调用Cookie:accept（路由ID：fairlane_cookie_consent_accept）。此路由仅接受POST请求。

待办事项

• 改进并丰富说明