Add {{cookiebar::show}} insert tag (#187)

zoglo · zoglo · commit 15fc5ff097cd · 2024-02-16T16:15:26.000+01:00
diff --git a/docs/BASICS.md b/docs/BASICS.md
@@ -3,7 +3,7 @@
     - [Create Configuration](CONFIGURATION.md)
     - [Create Group](GROUP.md)
     - [Create Cookie (Type)](COOKIE.md)
-- [Module & Content-Element](MOD_CE.md)
+- [Module / Content-Element / Insert-tags](MOD_CE_MISC.md)
 - [Styling & Customization](CUSTOMIZATION.md)
 - [Extend iFrame-Types](EXTEND_IFRAME.md)
 - [Extend Cookie-Types](EXTEND_TYPE.md)
diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md
@@ -3,7 +3,7 @@
     - [**Create Configuration**](CONFIGURATION.md)
     - [Create Group](GROUP.md)
     - [Create Cookie (Type)](COOKIE.md)
-- [Module & Content-Element](MOD_CE.md)
+- [Module / Content-Element / Insert-tags](MOD_CE_MISC.md)
 - [Styling & Customization](CUSTOMIZATION.md)
 - [Extend iFrame-Types](EXTEND_IFRAME.md)
 - [Extend Cookie-Types](EXTEND_TYPE.md)
diff --git a/docs/COOKIE.md b/docs/COOKIE.md
@@ -3,7 +3,7 @@
     - [Create Configuration](CONFIGURATION.md)
     - [Create Group](GROUP.md)
     - [**Create Cookie (Type)**](COOKIE.md)
-- [Module & Content-Element](MOD_CE.md)
+- [Module / Content-Element / Insert-tags](MOD_CE_MISC.md)
 - [Styling & Customization](CUSTOMIZATION.md)
 - [Extend iFrame-Types](EXTEND_IFRAME.md)
 - [Extend Cookie-Types](EXTEND_TYPE.md)
diff --git a/docs/CUSTOMIZATION.md b/docs/CUSTOMIZATION.md
@@ -3,7 +3,7 @@
     - [Create Configuration](CONFIGURATION.md)
     - [Create Group](GROUP.md)
     - [Create Cookie (Type)](COOKIE.md)
-- [Module & Content-Element](MOD_CE.md)
+- [Module / Content-Element / Insert-tags](MOD_CE_MISC.md)
 - [**Styling & Customization**](CUSTOMIZATION.md)
 - [Extend iFrame-Types](EXTEND_IFRAME.md)
 - [Extend Cookie-Types](EXTEND_TYPE.md)
diff --git a/docs/EXTENDED_USAGE.md b/docs/EXTENDED_USAGE.md
@@ -3,7 +3,7 @@
     - [Create Configuration](CONFIGURATION.md)
     - [Create Group](GROUP.md)
     - [Create Cookie (Type)](COOKIE.md)
-- [Module & Content-Element](MOD_CE.md)
+- [Module / Content-Element / Insert-tags](MOD_CE_MISC.md)
 - [Styling & Customization](CUSTOMIZATION.md)
 - [Extend iFrame-Types](EXTEND_IFRAME.md)
 - [Extend Cookie-Types](EXTEND_TYPE.md)
diff --git a/docs/EXTEND_IFRAME.md b/docs/EXTEND_IFRAME.md
@@ -3,7 +3,7 @@
     - [Create Configuration](CONFIGURATION.md)
     - [Create Group](GROUP.md)
     - [Create Cookie (Type)](COOKIE.md)
-- [Module & Content-Element](MOD_CE.md)
+- [Module / Content-Element / Insert-tags](MOD_CE_MISC.md)
 - [Styling & Customization](CUSTOMIZATION.md)
 - [**Extend iFrame-Types**](EXTEND_IFRAME.md)
 - [Extend Cookie-Types](EXTEND_TYPE.md)
diff --git a/docs/EXTEND_TYPE.md b/docs/EXTEND_TYPE.md
@@ -3,7 +3,7 @@
     - [Create Configuration](CONFIGURATION.md)
     - [Create Group](GROUP.md)
     - [Create Cookie (Type)](COOKIE.md)
-- [Module & Content-Element](MOD_CE.md)
+- [Module / Content-Element / Insert-tags](MOD_CE_MISC.md)
 - [Styling & Customization](CUSTOMIZATION.md)
 - [Extend iFrame-Types](EXTEND_IFRAME.md)
 - [**Extend Cookie-Types**](EXTEND_TYPE.md)
diff --git a/docs/GROUP.md b/docs/GROUP.md
@@ -3,7 +3,7 @@
     - [Create Configuration](CONFIGURATION.md)
     - [**Create Group**](GROUP.md)
     - [Create Cookie (Type)](COOKIE.md)
-- [Module & Content-Element](MOD_CE.md)
+- [Module / Content-Element / Insert-tags](MOD_CE_MISC.md)
 - [Styling & Customization](CUSTOMIZATION.md)
 - [Extend iFrame-Types](EXTEND_IFRAME.md)
 - [Extend Cookie-Types](EXTEND_TYPE.md)
diff --git a/docs/INSTALL.md b/docs/INSTALL.md
@@ -3,7 +3,7 @@
     - [Create Configuration](CONFIGURATION.md)
     - [Create Group](GROUP.md)
     - [Create Cookie (Type)](COOKIE.md)
-- [Module & Content-Element](MOD_CE.md)
+- [Module / Content-Element / Insert-tags](MOD_CE_MISC.md)
 - [Styling & Customization](CUSTOMIZATION.md)
 - [Extend iFrame-Types](EXTEND_IFRAME.md)
 - [Extend Cookie-Types](EXTEND_TYPE.md)
diff --git a/docs/MOD_CE.md b/docs/MOD_CE.md
diff --git a/docs/MOD_CE_MISC.md b/docs/MOD_CE_MISC.md
@@ -0,0 +1,74 @@
+- [Install](INSTALL.md)
+- [Configuration (Basics)](BASICS.md)
+    - [Create Configuration](CONFIGURATION.md)
+    - [Create Group](GROUP.md)
+    - [Create Cookie (Type)](COOKIE.md)
+- [**Module / Content-Element / Insert-tags**](MOD_CE_MISC.md)
+- [Styling & Customization](CUSTOMIZATION.md)
+- [Extend iFrame-Types](EXTEND_IFRAME.md)
+- [Extend Cookie-Types](EXTEND_TYPE.md)
+- [Extended usage](EXTENDED_USAGE.md)
+
+---
+
+# Module / Content-Element / Insert-tags
+In order to be able to open the cookie bar from all pages again and to give visitors the possibility to change their settings, the module / content element `Cookiebar` is provided.
+
+### Fields
+| Field              | Description                                                        |
+|--------------------|--------------------------------------------------------------------|
+| `Link text`        | The link text will be displayed instead of the target URL          |
+| `Link title`       | The link title is added as `title` attribute in the HTML markup    |
+| `Prefill settings` | Activates the already selected cookies when opening the cookie bar |
+
+### Template
+| Template                   | Description                                                                                           |
+|----------------------------|-------------------------------------------------------------------------------------------------------|
+| `ccb_opener_default.html5` | Returns the template, which is responsible for the output of the cookie bar module / content element. |
+
+## Open cookie bar via navigation
+Since version `1.10.0` it is possible to anchor the opening of the cookie bar in any navigation structure. A redirect page (internal redirect) can be set up, in which it is possible to define this page as the opener of the cookie bar. Afterwards, this page can be integrated into Contao and its navigation modules as usual. If JavaScript is not activated, the user will be redirected to the page that has been set up. This could in the best case point to data protection and privacy.
+
+## Insert tag
+Since version `1.14.0` it is possible to add open the cookie bar with following insert tag
+
+```{{cookiebar::show}}```
+
+The following parameters can be added to further customize the text, title and prefill options
+
+| Option             | Example                                                 | Default                                                     |
+|--------------------|---------------------------------------------------------|-------------------------------------------------------------|
+| `Link text`        | `{{cookiebar::show::My link name}}`                     | `$GLOBALS['TL_LANG']['tl_cookiebar']['changePrivacyLabel']` |
+| `Link title`       | `{{cookiebar::show::My link name::This is a title}}`    | empty                                                       |
+| `Prefill settings` | `{{cookiebar::show::My link name::This is a title::0}}` | 1 (true)                                                    | 
+
+
+## Create your own links to open the cookie bar 
+The following script can be used to reopen the cookie bar:
+```js
+cookiebar.show(true); // true = Activates the already confirmed cookie checkboxes
+```
+
+The link could look like this:
+```html
+<a href="javascript:cookiebar.show(true);">Privacy settings</a>
+```
+
+For use in the HTML editor of Contao, javascript may need to be added as a "protocol" in config.yml
+
+```
+contao:
+    sanitizer:
+        allowed_url_protocols:
+            - https
+            - http
+            - ftp
+            - mailto
+            - tel
+            - data
+            - skype
+            - whatsapp
+            - javascript
+```
+
+See also "[Extended usage](https://github.com/oveleon/contao-cookiebar/blob/master/docs/EXTENDED_USAGE.md)".
diff --git a/docs/README.md b/docs/README.md
@@ -4,7 +4,7 @@
   - [Create Configuration](CONFIGURATION.md)
   - [Create Group](GROUP.md)
   - [Create Cookie (Type)](COOKIE.md)
-- [Module & Content-Element](MOD_CE.md)
+- [Module / Content-Element / Insert-tags](MOD_CE_MISC.md)
 - [Styling & Customization](CUSTOMIZATION.md)
 - [Extend iFrame-Types](EXTEND_IFRAME.md)
 - [Extend Cookie-Types](EXTEND_TYPE.md)
diff --git a/src/DependencyInjection/ContaoCookiebarExtension.php b/src/DependencyInjection/ContaoCookiebarExtension.php
@@ -29,6 +29,7 @@ public function load(array $configs, ContainerBuilder $container)
         $loader->load('migrations.yml');
         $loader->load('commands.yml');
         $loader->load('services.yml');
+        $loader->load('listener.yml');
 
         $arrIframeTypes = [
             'youtube'       => ['ce_youtube'],
diff --git a/src/EventListener/InsertTagsListener.php b/src/EventListener/InsertTagsListener.php
@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of Oveleon Contao Cookiebar.
+ *
+ * @package     contao-cookiebar
+ * @license     AGPL-3.0
+ * @author      Daniele Sciannimanica <https://github.com/doishub>
+ * @copyright   Oveleon <https://www.oveleon.de/>
+ */
+
+namespace Oveleon\ContaoCookiebar\EventListener;
+
+use Contao\FrontendTemplate;
+use Contao\PageModel;
+use Contao\System;
+use Contao\StringUtil;
+use Contao\CoreBundle\Framework\ContaoFramework;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\Routing\RouterInterface;
+
+class InsertTagsListener
+{
+    private const SUPPORTED_TAGS = [
+        'cookiebar'
+    ];
+
+    /**
+     * @var ContaoFramework
+     */
+    private $framework;
+
+    private RouterInterface $router;
+    private RequestStack $requestStack;
+
+    public function __construct(ContaoFramework $framework, RouterInterface $router, RequestStack $requestStack)
+    {
+        $this->framework = $framework;
+        $this->router = $router;
+        $this->requestStack = $requestStack;
+    }
+
+	/**
+	 * @return string|false
+	 */
+    public function __invoke(string $tag, bool $useCache, $cacheValue, array $flags)
+	{
+		$elements = explode('::', $tag);
+		$key = strtolower($elements[0]);
+
+		if (\in_array($key, self::SUPPORTED_TAGS, true))
+		{
+			return $this->replaceCookiebarInsertTag($key, $elements, $flags);
+		}
+
+		return false;
+	}
+
+    private function replaceCookiebarInsertTag(string $insertTag, array $elements, array $flags): string
+    {
+        switch ($elements[1])
+        {
+            case 'show':
+                $objTemplate = new FrontendTemplate('ccb_opener_default');
+
+                $objTemplate->href = 'javascript:;';
+                $objTemplate->rel = ' rel="noreferrer noopener"';
+                $objTemplate->link = $elements[2] ?? ($GLOBALS['TL_LANG']['tl_cookiebar']['changePrivacyLabel'] ?? '');
+                $objTemplate->linkTitle = StringUtil::specialchars($elements[3] ?? '');
+                $objTemplate->attribute = ' onclick="cookiebar.show('.(isset($elements[4]) && !$elements[4] ? 0 : 1) .');"';
+
+                return $objTemplate->parse();
+        }
+
+        return '';
+    }
+}
diff --git a/src/Resources/config/listener.yml b/src/Resources/config/listener.yml
@@ -0,0 +1,10 @@
+services:
+  contao_cookiebar.listener.insert_tags:
+    class: Oveleon\ContaoCookiebar\EventListener\InsertTagsListener
+    arguments:
+      - '@contao.framework'
+      - '@router.default'
+      - '@request_stack'
+    tags:
+      - { name: contao.hook, hook: replaceInsertTags }
+    public: true
