Improve click action

williankeller · Jul 26, 2018 · 0dcb942 · 0dcb942
1 parent 7992fa0
commit 0dcb942
Show file tree

Hide file tree

Showing 10 changed files with 126 additions and 18 deletions.
diff --git a/Api/CookieHandlerInterface.php b/Api/CookieHandlerInterface.php
@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * A Magento 2 module named Magestat/CookieLawBanner
+ * Copyright (C) 2018 Magestat (http://magestat.com)
+ *
+ * This file included in Magestat/CookieLawBanner is licensed under OSL 3.0
+ *
+ * http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ * Please see LICENSE.txt for the full text of the OSL 3.0 license
+ */
+
+namespace Magestat\CookieLawBanner\Api;
+
+interface CookieHandlerInterface
+{
+    /**
+     * @var string Cookie name.
+     */
+    const COOKIE_NAME = 'm_cookie-law-banner';
+
+    /**
+     * Check if cookie exists.
+     *
+     * @return boolean
+     */
+    public function exists();
+}
diff --git a/Block/CookieLawBanner.php → Block/Banner.php b/Block/CookieLawBanner.php → Block/Banner.php
@@ -14,26 +14,35 @@
 
 use Magento\Catalog\Block\Product\Context;
 use Magestat\CookieLawBanner\Helper\Data;
+use Magestat\CookieLawBanner\Api\CookieHandlerInterface;
 
-class CookieLawBanner extends \Magento\Framework\View\Element\Template
+class Banner extends \Magento\Framework\View\Element\Template
 {    
     /**
      * @var \Magestat\CookieLawBanner\Helper\Data
      */
     protected $helperData;
 
+    /**
+     * @var \Magestat\CookieLawBanner\Api\CookieHandlerInterface
+     */
+    protected $cookieHandler;
+
     /**
      * @param Context $context
      * @param Data $helper
+     * @param CookieHandlerInterface $cookieHandler
      * @param array $data
      */
     public function __construct(
         Context $context,
         Data $helper,
+        CookieHandlerInterface $cookieHandler,
         array $data = []
     ) {
         parent::__construct($context, $data);
         $this->helperData = $helper;
+        $this->cookieHandler = $cookieHandler;
     }
 
     /**
@@ -51,7 +60,11 @@ public function _prepareLayout()
      */
     public function getIsEnabled()
     {
-        return $this->helperData->isActive();
+        if ($this->helperData->isActive() && !$this->cookieHandler->exists())
+        {
+            return true;
+        }
+        return false;
     }
 
     /**
@@ -101,6 +114,10 @@ public function getInfoLink()
      */
     public function getButton()
     {
-        return $this->helperData->getButton();
+        $button = $this->helperData->getButton();
+        if (empty($button)) {
+            return __('Accept');
+        }
+        return $button;
     }
 }
diff --git a/Helper/Data.php b/Helper/Data.php
@@ -46,7 +46,7 @@ public function getTitle()
     public function getMessage()
     {
         return $this->getConfigValue(
-            'magestat_cookielawbanner/general/description'
+            'magestat_cookielawbanner/general/message'
         );
     }
 
@@ -58,7 +58,7 @@ public function getMessage()
     public function getInfoMessage()
     {
         return $this->getConfigValue(
-            'magestat_cookielawbanner/general/text'
+            'magestat_cookielawbanner/general/details'
         );
     }
 

diff --git a/Model/CookieHandler.php b/Model/CookieHandler.php
@@ -0,0 +1,44 @@
+<?php
+
+/**
+ * A Magento 2 module named Magestat/CookieLawBanner
+ * Copyright (C) 2018 Magestat (http://magestat.com)
+ *
+ * This file included in Magestat/CookieLawBanner is licensed under OSL 3.0
+ *
+ * http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ * Please see LICENSE.txt for the full text of the OSL 3.0 license
+ */
+
+namespace Magestat\CookieLawBanner\Model;
+
+use Magento\Framework\Stdlib\CookieManagerInterface;
+use Magestat\CookieLawBanner\Api\CookieHandlerInterface;
+
+class CookieHandler implements CookieHandlerInterface
+{
+    /**
+     * @var \Magento\Framework\Stdlib\CookieManagerInterface
+     */
+    protected $cookieManager;
+
+    /**
+     * @param CookieManagerInterface $cookieManager
+     */
+    public function __construct(
+        CookieManagerInterface $cookieManager
+    ) {
+        $this->cookieManager = $cookieManager;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function exists()
+    {
+        if (empty($this->cookieManager->getCookie(self::COOKIE_NAME))) {
+            return false;
+        }
+        return true;
+    }
+}
diff --git a/etc/adminhtml/system.xml b/etc/adminhtml/system.xml
@@ -32,13 +32,13 @@
                     <label>Title</label>
                 </field>
                 <field id="message" translate="label" type="textarea" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
-                    <label>description</label>
+                    <label>Small Cookies Description</label>
                 </field>
-                <field id="text" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1">
-                    <label>More Information Link Text</label>
+                <field id="details" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1">
+                    <label>More Details Text</label>
                 </field>
                 <field id="link" translate="label" type="text" sortOrder="40" showInDefault="1" showInWebsite="1" showInStore="1">
-                    <label>More Information Link URL</label>
+                    <label>More Details Link of Text</label>
                 </field>
                 <field id="button" translate="label" type="text" sortOrder="50" showInDefault="1" showInWebsite="1" showInStore="1">
                     <label>Accept Button Text</label>

diff --git a/etc/config.xml b/etc/config.xml
@@ -16,9 +16,9 @@
             <general>
                 <title>Cookies Control</title>
                 <message>We use cookies to ensure that we give you the best experience on our website. If you continue to use this site we will assume that you are happy with it.</message>
-                <info_message>More info</info_message>
-                <info_link>/privacy-policy-cookie-restriction-mode</info_link>
-                <accept_button>Accept</accept_button>
+                <text>More info</text>
+                <link>/privacy-policy-cookie-restriction-mode</link>
+                <button>Accept</button>
             </general>
         </magestat_cookielawbanner>
     </default>

diff --git a/etc/di.xml b/etc/di.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * A Magento 2 module named Magestat/CookieLawBanner
+ * Copyright (C) 2018 Magestat (http://magestat.com)
+ *
+ * This file included in Magestat/CookieLawBanner is licensed under OSL 3.0
+ *
+ * http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
+ * Please see LICENSE.txt for the full text of the OSL 3.0 license
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
+    <!-- API Preferences -->
+    <preference for="Magestat\CookieLawBanner\Api\CookieHandlerInterface" type="Magestat\CookieLawBanner\Model\CookieHandler"/>
+</config>
diff --git a/view/frontend/layout/default.xml b/view/frontend/layout/default.xml
@@ -13,12 +13,12 @@
 <page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" layout="1column" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
     <body>
         <referenceBlock name="content">
-            <block class="Magestat\CookieLawBanner\Block\CookieLawBanner" name="magestat.cookie.law.banner" template="Magestat_CookieLawBanner::cookie-law-banner.phtml">
+            <block class="Magestat\CookieLawBanner\Block\Banner" name="magestat.cookie.law.banner" template="Magestat_CookieLawBanner::banner.phtml">
                 <arguments>
                     <argument name="jsLayout" xsi:type="array">
                         <item name="components" xsi:type="array">
                             <item name="magestat-cookie-law-banner" xsi:type="array">
-                                <item name="component" xsi:type="string">Magestat_CookieLawBanner/js/view/cookie-law-banner</item>
+                                <item name="component" xsi:type="string">Magestat_CookieLawBanner/js/view/banner</item>
                             </item>
                         </item>
                     </argument>

diff --git a/...rontend/templates/cookie-law-banner.phtml → view/frontend/templates/banner.phtml b/...rontend/templates/cookie-law-banner.phtml → view/frontend/templates/banner.phtml
diff --git a/...frontend/web/js/view/cookie-law-banner.js → view/frontend/web/js/view/banner.js b/...frontend/web/js/view/cookie-law-banner.js → view/frontend/web/js/view/banner.js
@@ -8,35 +8,38 @@
  * Please see LICENSE.txt for the full text of the OSL 3.0 license
  */
 define([
+    'uiComponent',
     'jquery',
-    'uiComponent'
-], function ($, Component) {
+    'jquery/jquery.cookie'
+], function (Component, $) {
     'use strict';
 
     return Component.extend({
         defaults: {
+            cookieName: 'm_cookie-law-banner',
             context: '#magestat-cookie-law-banner',
             button: '.button-accept'
         },
 
         /** @inheritdoc */
         initialize: function () {
             this._super();
-
             this.buttonClick();
         },
 
         /**
          * Trigger button click action.
          *
-         * @returns {magestat-cookie-law-banner}
+         * @returns {banner}
          */
         buttonClick: function () {
             var self = this;
 
             $(self.context).on('click', self.button, function () {
                 $(this).closest(self.context).addClass('remove');
             });
+            $.cookie(self.cookieName, 'accepted');
+
             return self;
         }
     });