#94738 add customer groups to nodes (#298)

* #94738 add serialized customer groups field to nodes --------- Co-authored-by: Ola <[email protected]>
SnowdogApps · Aug 1, 2024 · 6d8bc3e · 6d8bc3e
1 parent 0024ff2
commit 6d8bc3e
Show file tree

Hide file tree

Showing 23 changed files with 450 additions and 538 deletions.
diff --git a/Api/Data/NodeInterface.php b/Api/Data/NodeInterface.php
@@ -25,6 +25,7 @@ interface NodeInterface
     const IS_ACTIVE = 'is_active';
     const ADDITIONAL_DATA = 'additional_data';
     const SELECTED_ITEM_ID = 'selected_item_id';
+    const CUSTOMER_GROUPS = 'customer_groups';
 
     /**
      * Get node id
@@ -298,4 +299,21 @@ public function getSelectedItemId();
      * @return $this
      */
     public function setSelectedItemId($selectedItemId);
+
+    /**
+     * Get customer groups
+     *
+     */
+    public function getCustomerGroups();
+
+    /**
+     * @return $this
+     */
+    public function setCustomerGroups($customerGroups);
+
+    /**
+     * @param int $customerGroupId
+     * @return bool
+     */
+    public function isVisible($customerGroupId);
 }
diff --git a/Block/Adminhtml/Edit/Tab/Nodes.php b/Block/Adminhtml/Edit/Tab/Nodes.php
@@ -7,6 +7,7 @@
 use Magento\Framework\Registry;
 use Snowdog\Menu\Api\NodeRepositoryInterface;
 use Snowdog\Menu\Controller\Adminhtml\Menu\Edit;
+use Snowdog\Menu\Model\CustomerGroupsProvider;
 use Snowdog\Menu\Model\Menu\Node\Image\File as ImageFile;
 use Snowdog\Menu\Model\NodeTypeProvider;
 use Snowdog\Menu\Model\VueProvider;
@@ -45,13 +46,19 @@ class Nodes extends Template implements TabInterface
      */
     private $vueProvider;
 
+    /**
+     * @var CustomerGroupsProvider
+     */
+    private $customerGroupsProvider;
+
     public function __construct(
         Template\Context $context,
         NodeRepositoryInterface $nodeRepository,
         ImageFile $imageFile,
         NodeTypeProvider $nodeTypeProvider,
         Registry $registry,
         VueProvider $vueProvider,
+        CustomerGroupsProvider $customerGroupsProvider,
         array $data = []
     ) {
         parent::__construct($context, $data);
@@ -60,6 +67,7 @@ public function __construct(
         $this->nodeTypeProvider = $nodeTypeProvider;
         $this->imageFile = $imageFile;
         $this->vueProvider = $vueProvider;
+        $this->customerGroupsProvider = $customerGroupsProvider;
     }
 
     public function renderNodes()
@@ -185,7 +193,8 @@ private function renderNodeList($level, $parent, $data)
                 'image_width' => $node->getImageWidth(),
                 'image_height' => $node->getImageHeight(),
                 'columns' => $this->renderNodeList($level + 1, $node->getId(), $data) ?: [],
-                'selected_item_id' => $node->getSelectedItemId()
+                'selected_item_id' => $node->getSelectedItemId(),
+                'customer_groups' => $node->getCustomerGroups()
             ];
         }
         return $menu;
@@ -208,4 +217,9 @@ public function getVueComponents(): array
     {
         return $this->vueProvider->getComponents();
     }
+
+    public function getCustomerGroups()
+    {
+        return $this->customerGroupsProvider->getAll();
+    }
 }
diff --git a/Block/Menu.php b/Block/Menu.php
@@ -2,9 +2,8 @@
 
 namespace Snowdog\Menu\Block;
 
-use Magento\Framework\Api\Search\FilterGroupBuilder;
-use Magento\Framework\Api\Search\SearchCriteriaFactory;
 use Magento\Framework\App\Cache\Type\Block;
+use Magento\Framework\App\Http\Context;
 use Magento\Framework\DataObject;
 use Magento\Framework\View\Element\Template;
 use Magento\Framework\Event\Manager as EventManager;
@@ -19,9 +18,13 @@
 
 /**
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+ * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
  */
 class Menu extends Template implements DataObject\IdentityInterface
 {
+    const XML_SNOWMENU_GENERAL_CUSTOMER_GROUPS = 'snowmenu/general/customer_groups';
+
     /**
      * @var MenuRepositoryInterface
      */
@@ -41,15 +44,6 @@ class Menu extends Template implements DataObject\IdentityInterface
 
     private $menu = null;
 
-    /**
-     * @var SearchCriteriaFactory
-     */
-    private $searchCriteriaFactory;
-
-    /**
-     * @var FilterGroupBuilder
-     */
-    private $filterGroupBuilder;
     /**
      * @var EventManager
      */
@@ -85,6 +79,11 @@ class Menu extends Template implements DataObject\IdentityInterface
      */
     private $escaper;
 
+    /**
+     * @var Context
+     */
+    private $httpContext;
+
     /**
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
@@ -94,25 +93,23 @@ public function __construct(
         MenuRepositoryInterface $menuRepository,
         NodeRepositoryInterface $nodeRepository,
         NodeTypeProvider $nodeTypeProvider,
-        SearchCriteriaFactory $searchCriteriaFactory,
-        FilterGroupBuilder $filterGroupBuilder,
         TemplateResolver $templateResolver,
         ImageFile $imageFile,
         Escaper $escaper,
+        Context $httpContext,
         array $data = []
     ) {
         parent::__construct($context, $data);
         $this->menuRepository = $menuRepository;
         $this->nodeRepository = $nodeRepository;
         $this->nodeTypeProvider = $nodeTypeProvider;
-        $this->searchCriteriaFactory = $searchCriteriaFactory;
-        $this->filterGroupBuilder = $filterGroupBuilder;
         $this->eventManager = $eventManager;
         $this->templateResolver = $templateResolver;
         $this->imageFile = $imageFile;
         $this->escaper = $escaper;
         $this->setTemplate($this->getMenuTemplate($this->_template));
         $this->submenuTemplate = $this->getSubmenuTemplate();
+        $this->httpContext = $httpContext;
     }
 
     /**
@@ -178,6 +175,9 @@ public function getCacheKeyInfo()
         if ($nodeCacheKeyInfo) {
             $info = array_merge($info, $nodeCacheKeyInfo);
         }
+        if ($this->_scopeConfig->isSetFlag(self::XML_SNOWMENU_GENERAL_CUSTOMER_GROUPS)) {
+            $info[] = 'cust_group_' . $this->getCustomerGroupId();
+        }
 
         return $info;
     }
@@ -410,7 +410,8 @@ private function getMenuNodeBlock($node)
             ->setImageAltText($node->getImageAltText())
             ->setCustomTemplate($node->getNodeTemplate())
             ->setAdditionalData($node->getAdditionalData())
-            ->setSelectedItemId($node->getSelectedItemId());
+            ->setSelectedItemId($node->getSelectedItemId())
+            ->setCustomerGroups($node->getCustomerGroups());
 
         return $nodeBlock;
     }
@@ -442,12 +443,17 @@ private function getSubmenuBlock($nodes, $parentNode, $level = 0)
     private function fetchData()
     {
         $nodes = $this->nodeRepository->getByMenu($this->loadMenu()->getId());
+        $currentCustomerGroup = $this->getCustomerGroupId();
+        $customerGroupEnabled = $this->_scopeConfig->getValue(self::XML_SNOWMENU_GENERAL_CUSTOMER_GROUPS);
         $result = [];
         $types = [];
         foreach ($nodes as $node) {
             if (!$node->getIsActive()) {
                 continue;
             }
+            if ($customerGroupEnabled && !$node->isVisible($currentCustomerGroup)) {
+                continue;
+            }
 
             $level = $node->getLevel();
             $parent = $node->getParentId() ?: 0;
@@ -502,4 +508,9 @@ private function getSubmenuTemplate()
 
         return $this->getMenuTemplate($baseSubmenuTemplate);
     }
+
+    public function getCustomerGroupId()
+    {
+        return $this->httpContext->getValue(\Magento\Customer\Model\Context::CONTEXT_GROUP);
+    }
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [Unreleased]
 ### Added
 - `width` and `height` attributes to menu node images (DEV-102271)
+- Option to specify customer groups for each node (DEV-94738)
 - Snowdog branding in admin panel (DEV-105762)
 - Automatically open collapsed menu node when dragging another node inside (DEV-101986)
 - Duplicate node functionality (DEV-104364)

diff --git a/Model/CustomerGroupsProvider.php b/Model/CustomerGroupsProvider.php
@@ -0,0 +1,35 @@
+<?php
+
+namespace Snowdog\Menu\Model;
+
+use Magento\Customer\Model\Group;
+use Magento\Customer\Model\ResourceModel\Group\CollectionFactory as GroupCollectionFactory;
+
+class CustomerGroupsProvider
+{
+    /**
+     * @var GroupCollectionFactory
+     */
+    private $groupCollectionFactory;
+
+    public function __construct(
+        GroupCollectionFactory $groupCollectionFactory
+    ) {
+        $this->groupCollectionFactory = $groupCollectionFactory;
+    }
+
+    public function getAll()
+    {
+        $customerGroups = [];
+
+        /** @var Group $customerGroup */
+        foreach ($this->groupCollectionFactory->create() as $customerGroup) {
+            $customerGroups[] = [
+                'label' => $customerGroup->getCode(),
+                'value' => $customerGroup->getId()
+            ];
+        }
+
+        return $customerGroups;
+    }
+}
diff --git a/Model/GraphQl/Resolver/DataProvider/Node.php b/Model/GraphQl/Resolver/DataProvider/Node.php
@@ -111,7 +111,9 @@ private function convertData(NodeInterface $node): array
             self::SUBMENU_TEMPLATE_FIELD => $node->getSubmenuTemplate(),
             NodeInterface::CREATION_TIME => $node->getCreationTime(),
             NodeInterface::UPDATE_TIME => $node->getUpdateTime(),
-            NodeInterface::ADDITIONAL_DATA => $node->getAdditionalData()
+            NodeInterface::ADDITIONAL_DATA => $node->getAdditionalData(),
+            NodeInterface::SELECTED_ITEM_ID => $node->getSelectedItemId(),
+            NodeInterface::CUSTOMER_GROUPS => $node->getCustomerGroups()
         ];
     }
 

diff --git a/Model/Menu/Node.php b/Model/Menu/Node.php
@@ -1,14 +1,36 @@
 <?php
 namespace Snowdog\Menu\Model\Menu;
 
+use Magento\Framework\Data\Collection\AbstractDb;
 use Magento\Framework\DataObject\IdentityInterface;
 use Magento\Framework\Model\AbstractModel;
+use Magento\Framework\Model\Context;
+use Magento\Framework\Model\ResourceModel\AbstractResource as AbstractResource;
+use Magento\Framework\Registry;
+use Magento\Framework\Serialize\SerializerInterface;
 use Snowdog\Menu\Api\Data\NodeInterface;
 
 class Node extends AbstractModel implements NodeInterface, IdentityInterface
 {
     const CACHE_TAG = 'snowdog_menu_node';
 
+    /**
+     * @var SerializerInterface
+     */
+    private $serializer;
+
+    public function __construct(
+        Context $context,
+        Registry $registry,
+        SerializerInterface $serializer,
+        AbstractResource $resource = null,
+        AbstractDb $resourceCollection = null,
+        array $data = []
+    ) {
+        parent::__construct($context, $registry, $resource, $resourceCollection, $data);
+        $this->serializer = $serializer;
+    }
+
     protected function _construct()
     {
         $this->_init(\Snowdog\Menu\Model\ResourceModel\Menu\Node::class);
@@ -325,4 +347,48 @@ public function setSelectedItemId($selectedItemId)
     {
         return $this->setData(NodeInterface::SELECTED_ITEM_ID, $selectedItemId);
     }
+
+    public function getCustomerGroups()
+    {
+        $customerGroups = $this->_getData(NodeInterface::CUSTOMER_GROUPS);
+        if ($customerGroups == null) {
+            return [];
+        }
+        $customerGroups = explode(',', $customerGroups);
+        if (is_array($customerGroups) && !empty($customerGroups)) {
+            return $customerGroups;
+        }
+
+        return [];
+    }
+
+    public function setCustomerGroups($customerGroups)
+    {
+        if (empty($customerGroups)) {
+            $this->setData(NodeInterface::CUSTOMER_GROUPS);
+            return $this;
+        }
+
+        if (is_string($customerGroups) && $this->serializer->unserialize($customerGroups)) {
+            return $this->setData(NodeInterface::CUSTOMER_GROUPS, $customerGroups);
+        }
+
+        return $this->setData(NodeInterface::CUSTOMER_GROUPS, $this->serializer->serialize($customerGroups));
+    }
+
+    public function isVisible($customerGroupId)
+    {
+        $customerGroups = $this->getCustomerGroups();
+        if (empty($customerGroups)) {
+            return true;
+        }
+
+        foreach ($customerGroups as $customerGroup) {
+            if ((int) $customerGroup === (int) $customerGroupId) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }
diff --git a/Model/Menu/Node/Image/Node.php b/Model/Menu/Node/Image/Node.php
@@ -67,7 +67,7 @@ public function updateNodeImage(int $nodeId, ?string $image): void
     public function getNodeListImages(array $nodeIds): array
     {
         $searchCriteria = $this->searchCriteriaBuilder
-            ->addFilter(NodeInterface::NODE_ID, $nodeIds, 'in')
+            ->addFilter('main_table.' . NodeInterface::NODE_ID, $nodeIds, 'in')
             ->addFilter(NodeInterface::IMAGE, true, 'notnull')
             ->addFilter(NodeInterface::IMAGE, '', 'neq')
             ->create();

diff --git a/Model/Menu/NodeRepository.php b/Model/Menu/NodeRepository.php
@@ -15,6 +15,7 @@
 use Snowdog\Menu\Model\Menu\NodeFactory;
 use Snowdog\Menu\Model\ResourceModel\Menu\Node\CollectionFactory;
 use Magento\Framework\Api\SortOrder;
+use Magento\Framework\DB\Sql\Expression;
 
 class NodeRepository implements NodeRepositoryInterface
 {