Skip to content

INSTALLATION.md

Latest commit

 

History

History
130 lines (87 loc) · 4.46 KB

INSTALLATION.md

File metadata and controls

130 lines (87 loc) · 4.46 KB
Raw

Installation

Table of contents

Requirements

  • FormKitBundle (nowo-tech/form-kit-bundle ^2.0) — dashboard/admin Symfony forms (FormOptionsTrait, profile cookie_consent). Register NowoFormKitBundle in config/bundles.php (Flex / demo). Optional host YAML: config/packages/nowo_form_kit.yaml.

  • PHP >=8.1 (<8.6). Symfony 8.0 and 8.1 require PHP 8.4+.

  • Symfony 7.4, 8.0, or 8.1 (minimum tested minors). The bundle also supports Symfony 6.x and 7.0–7.3 when constraints resolve.

  • Doctrine ORM (when use_logger: true or use_database_config: true)

Composer

composer require nowo-tech/cookie-consent-bundle

Enable the bundle

With Symfony Flex

The recipe enables the bundle, adds config/packages/nowo_cookie_consent.yaml, and imports routes in config/routes/nowo_cookie_consent.yaml. Adjust configuration as needed (see Configuration).

Without Flex

Register the bundle manually:

// config/bundles.php
Nowo\CookieConsentBundle\NowoCookieConsentBundle::class => ['all' => true],

Create config/packages/nowo_cookie_consent.yaml:

nowo_cookie_consent:
    use_logger: true

Routes

# config/routes/nowo_cookie_consent.yaml
nowo_cookie_consent:
    resource: '@NowoCookieConsentBundle/Resources/config/routing.yaml'

Assets

php bin/console assets:install

This publishes src/Resources/public to public/bundles/nowocookieconsent/ (nowo-consent-modal.js, nowo-cookie-consent.css). By default the JS injects modal styles at runtime. For CSP policies that use style-src nonces (injected <style> tags are ignored), link the standalone CSS instead:

<link rel="stylesheet"
      href="{{ asset('nowo-cookie-consent.css', 'nowo_cookie_consent') }}"
      data-nowo-cookie-consent-css>
<script src="{{ asset('nowo-consent-modal.js', 'nowo_cookie_consent') }}" defer></script>

The data-nowo-cookie-consent-css marker tells the modal script to skip <style> injection. Templates that use the bundled fragment already load the JS via asset('nowo-consent-modal.js', 'nowo_cookie_consent'); add the <link> in your layout <head> when needed.

AssetMapper

If your app uses Symfony AssetMapper, the bundle registers the nowo_cookie_consent asset package. Run assets:install once so nowo-consent-modal.js and nowo-cookie-consent.css are published to public/bundles/nowocookieconsent/.

Contributors rebuild frontend assets with:

make assets

Database

When logging is enabled, create the schema for Nowo\CookieConsentBundle\Entity\CookieConsentLog:

php bin/console doctrine:schema:update --force

Or generate a migration in your application.

Default table name: dashboard_cookie_log. Use doctrine.table_prefix in configuration to namespace tables per application.

When use_database_config and use_cookie_inventory are enabled, also create:

  • {prefix}dashboard_cookie_config
  • {prefix}dashboard_cookie_config_translation
  • {prefix}dashboard_cookie_definition
  • {prefix}dashboard_cookie_definition_translation

Twig Extra Bundle (REQ-TWIG-004)

This package ships Twig templates. Host applications must install and enable Twig Extra:

composer require twig/extra-bundle twig/string-extra

Register Twig\Extra\TwigExtraBundle\TwigExtraBundle in config/bundles.php (Flex usually does this). Demos already include the same stack. The package release-check runs make check-twig-extra to guard this contract.

UiKit Bundle (REQ-UI-001)

Admin pages compose UiKitBundle (nowo-tech/ui-kit-bundle ^1.4, required by this package). Hosts get it transitively; register the bundle when not using Flex auto-discovery:

// config/bundles.php
Nowo\UiKitBundle\NowoUiKitBundle::class => ['all' => true],

Then install public assets (UiKit nowo_ui_kit package + this bundle’s modal assets):

php bin/console assets:install

Admin shells load UiKit nowo-ui.css / nowo-ui-confirm.js via admin/base.html.twig. Cookie-consent modal CSS/JS stay on the nowo_cookie_consent asset package.