Issue #2 - Add badge notification config setting

magepal · Jul 13, 2020 · cb8ce32 · cb8ce32
1 parent 0f4270c
commit cb8ce32
Show file tree

Hide file tree

Showing 8 changed files with 138 additions and 9 deletions.
diff --git a/Block/Adminhtml/Badge.php b/Block/Adminhtml/Badge.php
@@ -9,23 +9,60 @@
 
 use Magento\Backend\Block\Template;
 use MagePal\Core\Controller\Adminhtml\Version\Index;
+use MagePal\Core\Helper\Data;
 
 class Badge extends Template
 {
-    const SEARCH_URL = 'https://www.magepal.com/catalogsearch/result/?utm_source=search&utm_medium=admin&utm_campaign=core';
+    const SEARCH_URL = 'https://www.magepal.com/catalogsearch/result/';
+    /**
+     * @var Data
+     */
+    private $dataHelper;
 
+    /**
+     * Badge constructor.
+     * @param Template\Context $context
+     * @param Data $dataHelper
+     * @param array $data
+     */
+    public function __construct(
+        Template\Context $context,
+        Data $dataHelper,
+        array $data = []
+    ) {
+        parent::__construct($context, $data);
+        $this->dataHelper = $dataHelper;
+    }
+
+    /**
+     * @return bool
+     */
+    public function getNotificationOption()
+    {
+        return $this->dataHelper->getBadgeNotificationValue();
+    }
+
+    /**
+     * @return string
+     */
     public function getNotificationUrl()
     {
         return $this->getUrl('magepal/version/index');
     }
 
+    /**
+     * @return bool
+     */
     public function isAuthorized()
     {
         return $this->_authorization->isAllowed(Index::ADMIN_RESOURCE);
     }
 
+    /**
+     * @return string
+     */
     public function getSearchUrl()
     {
-        return self::SEARCH_URL;
+        return self::SEARCH_URL . '?utm_source=search&utm_medium=admin&utm_campaign=core';
     }
 }
diff --git a/Helper/Data.php b/Helper/Data.php
@@ -0,0 +1,34 @@
+<?php
+/**
+ * Copyright © MagePal LLC. All rights reserved.
+ * See COPYING.txt for license details.
+ * https://www.magepal.com | [email protected]
+ */
+
+namespace MagePal\Core\Helper;
+
+use Magento\Framework\App\Helper\AbstractHelper;
+use Magento\Store\Model\ScopeInterface;
+
+class Data extends AbstractHelper
+{
+    const XML_PATH_ACTIVE = 'magepal_core/general/badge_notification';
+    const NOTIFICATION_DISABLED = 0;
+    const NOTIFICATION_ENABLED = 1;
+    const NOTIFICATION_WITHIN_TAB = 2;
+
+    /**
+     * If enabled
+     *
+     * @param null $scopeCode
+     * @return bool
+     */
+    public function getBadgeNotificationValue($scopeCode = null)
+    {
+        return (int) $this->scopeConfig->getValue(
+            self::XML_PATH_ACTIVE,
+            ScopeInterface::SCOPE_STORE,
+            $scopeCode
+        );
+    }
+}
diff --git a/Model/Config/Source/BadgeNotification.php b/Model/Config/Source/BadgeNotification.php
@@ -0,0 +1,26 @@
+<?php
+/**
+ * Copyright © MagePal LLC. All rights reserved.
+ * See COPYING.txt for license details.
+ * http://www.magepal.com | [email protected]
+ */
+
+namespace MagePal\Core\Model\Config\Source;
+
+use Magento\Framework\Option\ArrayInterface;
+use MagePal\Core\Helper\Data;
+
+class BadgeNotification implements ArrayInterface
+{
+    /**
+     * @return array
+     */
+    public function toOptionArray()
+    {
+        return [
+            ['value' => Data::NOTIFICATION_ENABLED, 'label' => 'Yes'],
+            ['value' => Data::NOTIFICATION_WITHIN_TAB, 'label' => 'When Tab Open'],
+            ['value' => Data::NOTIFICATION_DISABLED, 'label' => __('No')]
+        ];
+    }
+}
diff --git a/composer.json b/composer.json
@@ -23,12 +23,9 @@
     ],
     "require": {
         "magento/framework": "100.0.*|100.1.*|101.0.*|102.0.*"
-    },
-    "suggest": {
-
     },
     "type": "magento2-module",
-    "version": "1.1.4",
+    "version": "1.1.5",
     "autoload": {
         "files": [
             "registration.php"

diff --git a/etc/adminhtml/system.xml b/etc/adminhtml/system.xml
@@ -25,6 +25,14 @@
                 <attribute type="expanded">1</attribute>
                 <frontend_model>MagePal\Core\Block\Adminhtml\System\Config\Field\Extensions</frontend_model>
             </group>
+            <group id="general" showInDefault="1" showInStore="1" showInWebsite="1" sortOrder="20" translate="label">
+                <label>Setting</label>
+                <field id="badge_notification" translate="label" type="select" sortOrder="2" showInDefault="1" showInWebsite="1" showInStore="1">
+                    <label>Show Badge Notification</label>
+                    <source_model>MagePal\Core\Model\Config\Source\BadgeNotification</source_model>
+                    <comment><![CDATA[When Tab Open - Badge update count only shows when MagePal tab is expanded, in the "Notifications & Updates" section.]]></comment>
+                </field>
+            </group>
         </section>
     </system>
 </config>
diff --git a/etc/config.xml b/etc/config.xml
@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © MagePal LLC. All rights reserved.
+ * See COPYING.txt for license details.
+ * https://www.magepal.com | [email protected]
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
+    <default>
+        <magepal_core>
+            <general>
+                <badge_notification>1</badge_notification>
+            </general>
+        </magepal_core>
+    </default>
+</config>
diff --git a/view/adminhtml/templates/badge.phtml b/view/adminhtml/templates/badge.phtml
@@ -13,7 +13,8 @@
         "*": {
             "magePalCoreNotificationIcon": {
                 "url":"<?= $block->escapeUrl($block->getNotificationUrl()) ?>",
-                "searchUrl":"<?= $block->escapeUrl($block->getSearchUrl()) ?>"
+                "searchUrl":"<?= $block->escapeUrl($block->getSearchUrl()) ?>",
+                "notificationOption": "<?= $block->getNotificationOption() ?>"
             }
         }
     }

diff --git a/view/adminhtml/web/js/notification-icon.js b/view/adminhtml/web/js/notification-icon.js
@@ -16,7 +16,7 @@ define([
     var html = '<span class="mp-logo"></span>';
     $element.before(html);
 
-    return function (config) {
+    var showBadge = function (config) {
         $.ajax({
             url: config.url,
             type: 'get',
@@ -25,10 +25,19 @@ define([
         }).done(function (response) {
             if (typeof response === 'object' && response.hasOwnProperty('count') && response.count > 0) {
                 var html = '<span class="notifications-counter">' + response.count + '</span>';
-                $element.append(html);
+                if (config.notificationOption !== 1) {
+                    $element.append(html);
+                }
+
                 $element.parent().parent().find('ul.items li.item:first').append(html)
             }
         });
+    };
+
+    return function (config) {
+        if (config.notificationOption !== 0) {
+            showBadge(config);
+        }
 
         var openWindow = function ($element) {
             if ($($element).val().length > 2) {