Merge pull request #16 from outeredge/use-subcategories

use subcategories option added to menu items

Api/Data/ItemInterface.php

@@ -11,17 +11,18 @@ interface ItemInterface
     /**#@+
      * Constants for keys of data array. Identical to the name of the getter in snake case
      */
-    const ITEM_ID     = 'item_id';
-    const MENU_ID     = 'menu_id';
-    const PARENT_ID   = 'parent_id';
-    const TITLE       = 'title';
-    const DESCRIPTION = 'description';
-    const URL         = 'url';
-    const IMAGE       = 'image';
-    const PRODUCT_ID  = 'product_id';
-    const CATEGORY_ID = 'category_id';
-    const PAGE_ID     = 'page_id';
-    const SORT_ORDER  = 'sort_order';
+    const ITEM_ID           = 'item_id';
+    const MENU_ID           = 'menu_id';
+    const PARENT_ID         = 'parent_id';
+    const TITLE             = 'title';
+    const DESCRIPTION       = 'description';
+    const URL               = 'url';
+    const IMAGE             = 'image';
+    const PRODUCT_ID        = 'product_id';
+    const CATEGORY_ID       = 'category_id';
+    const USE_SUBCATEGORIES = 'use_subcategories';
+    const PAGE_ID           = 'page_id';
+    const SORT_ORDER        = 'sort_order';
     /**#@-*/
 
     /**
@@ -86,6 +87,13 @@ public function getProductId();
      * @return int|null
      */
     public function getCategoryId();
+
+    /**
+     * Get use subcategories
+     *
+     * @return int|null
+     */
+    public function getUseSubcategories();
 
     /**
      * Get page ID
@@ -172,6 +180,14 @@ public function setProductId($productId);
      * @return $this
      */
     public function setCategoryId($categoryId);
+
+    /**
+     * Set use subcategories
+     *
+     * @param int $useSubcategories
+     * @return $this
+     */
+    public function setUseSubcategories($useSubcategories);
 
     /**
      * Set page ID

Helper/Menu.php

@@ -3,10 +3,17 @@
 namespace OuterEdge\Menu\Helper;
 
 use Magento\Framework\App\Helper\AbstractHelper;
+use OuterEdge\Menu\Model\Menu as MenuModel;
 use OuterEdge\Menu\Model\MenuFactory as MenuFactory;
+use OuterEdge\Menu\Model\ResourceModel\Item\Collection as ItemCollection;
 use OuterEdge\Menu\Model\ResourceModel\Item\CollectionFactory as ItemCollectionFactory;
-use OuterEdge\Menu\Model\Menu as MenuModel;
+use OuterEdge\Menu\Model\Item;
+use OuterEdge\Menu\Model\ItemFactory;
 use Magento\Framework\Escaper;
+use Magento\Store\Model\StoreManagerInterface;
+use Magento\Catalog\Model\ResourceModel\Category\Collection as CategoryCollection;
+use Magento\Catalog\Model\ResourceModel\Category\CollectionFactory as CategoryCollectionFactory;
+use Magento\Framework\Data\Collection;
 
 class Menu extends AbstractHelper
 {
@@ -19,28 +26,60 @@ class Menu extends AbstractHelper
      * @var ItemCollectionFactory
      */
     private $itemCollectionFactory;
+
+    /**
+     * @var ItemFactory
+     */
+    private $itemFactory;
 
     /**
      * @var Escaper
      */
     private $escaper;
-
+
+    /**
+     * @var StoreManagerInterface
+     */
+    private $storeManager;
+
+    /**
+     * @var CategoryCollectionFactory
+     */
+    private $categoryCollectionFactory;
+
     /**
      * @param MenuFactory $menuFactory
      * @param ItemCollectionFactory $itemCollectionFactory
+     * @param ItemFactory $itemFactory
      * @param Escaper $escaper
+     * @param StoreManagerInterface $storeManager
+     * @param CategoryCollectionFactory $categoryCollectionFactory
      * @codeCoverageIgnore
      */
     public function __construct(
         MenuFactory $menuFactory,
         ItemCollectionFactory $itemCollectionFactory,
-        Escaper $escaper
+        ItemFactory $itemFactory,
+        Escaper $escaper,
+        StoreManagerInterface $storeManager,
+        CategoryCollectionFactory $categoryCollectionFactory
     ) {
         $this->menuFactory = $menuFactory;
         $this->itemCollectionFactory = $itemCollectionFactory;
+        $this->itemFactory = $itemFactory;
         $this->escaper = $escaper;
+        $this->storeManager = $storeManager;
+        $this->categoryCollectionFactory = $categoryCollectionFactory;
     }
-
+
+    /**
+     * Get menu html public wrapper
+     *
+     * @param MenuModel|int|string $menu
+     * @param boolean $includeWrapper
+     * @param boolean $loadByCode
+     * @return string
+     */
     public function getMenuHtml($menu, $includeWrapper = false, $loadByCode = false)
     {
         if ($menu instanceof MenuModel) {
@@ -59,7 +98,14 @@ public function getMenuHtml($menu, $includeWrapper = false, $loadByCode = false)
 
         return $this->_getMenuHtml($menuModel, $includeWrapper);
     }
-
+
+    /**
+     * Get menu html protected
+     *
+     * @param MenuModel $menu
+     * @param boolean $includeWrapper
+     * @return string
+     */
     protected function _getMenuHtml($menu, $includeWrapper = false)
     {
         $items = $this->itemCollectionFactory->create()
@@ -74,13 +120,24 @@ protected function _getMenuHtml($menu, $includeWrapper = false)
         }
         return $menuHtml;
     }
-
+
+    /**
+     * Add sub menu html to menu
+     *
+     * @param ItemCollection $items
+     * @param int $level
+     * @return string
+     */
     protected function _addSubMenu($items, $level = 0)
     {
         $html = '';
 
         foreach ($items as $item) {
             $children = $this->_getItemChildren($item);
+
+            if ($item->getCategoryId() && $item->getUseSubcategories()) {
+                $this->_addSubcategoriesToChildren($children, $item->getCategoryId(), $level + 1);
+            }
 
             $item->setLevel($level);
             $item->setChildren($children->count());
@@ -111,7 +168,13 @@ protected function _addSubMenu($items, $level = 0)
 
         return $html;
     }
-
+
+    /**
+     * Get item classes for menu item
+     *
+     * @param Item $item
+     * @return string
+     */
     protected function _getItemClasses($item)
     {
         $classes = ['level' . $item->getLevel()];
@@ -126,11 +189,64 @@ protected function _getItemClasses($item)
         }
         return implode(' ', $classes);
     }
-
+
+    /**
+     * Get menu item children collection
+     *
+     * @param Item $item
+     * @return ItemCollection
+     */
     protected function _getItemChildren($item)
     {
         return $this->itemCollectionFactory->create()
             ->addFieldToFilter('parent_id', ['eq' => $item->getId()])
             ->setOrder('sort_order', 'ASC');
     }
+
+    /**
+     * Add default magento categories to children collection
+     *
+     * @param ItemCollection $children
+     * @param int $categoryId
+     * @param int $level
+     * @return void
+     */
+    protected function _addSubcategoriesToChildren(&$children, $categoryId, $level)
+    {
+        $storeId = $this->storeManager->getStore()->getId();
+
+        $subCategories = $this->getSubCategories($storeId, $categoryId);
+        foreach ($subCategories as $subCategory) {
+            $item = $this->itemFactory->create();
+            $item->setData([
+                'title'             => $subCategory->getName(),
+                'category_id'       => $subCategory->getId(),
+                'use_subcategories' => true
+            ]);
+            $children->addItem($item);
+        }
+    }
+
+    /**
+     * Load magento category collection from parent category
+     *
+     * @param int $storeId
+     * @param int $categoryId
+     * @return CategoryCollection
+     */
+    protected function getSubCategories($storeId, $categoryId)
+    {
+        $collection = $this->categoryCollectionFactory->create();
+        $collection->setStoreId($storeId);
+        $collection->addAttributeToSelect('name');
+        $collection->addFieldToFilter('parent_id', $categoryId);
+        $collection->addAttributeToFilter('include_in_menu', 1);
+        $collection->addIsActiveFilter();
+        $collection->addUrlRewriteToResult();
+        $collection->addOrder('level', Collection::SORT_ORDER_ASC);
+        $collection->addOrder('position', Collection::SORT_ORDER_ASC);
+        $collection->addOrder('parent_id', Collection::SORT_ORDER_ASC);
+        $collection->addOrder('entity_id', Collection::SORT_ORDER_ASC);
+        return $collection;
+    }
 }

Model/Item.php

@@ -140,6 +140,16 @@ public function getCategoryId()
     {
         return parent::getData(self::CATEGORY_ID);
     }
+
+    /**
+     * Get use subcategories
+     *
+     * @return int
+     */
+    public function getUseSubcategories()
+    {
+        return parent::getData(self::USE_SUBCATEGORIES);
+    }
 
     /**
      * Get page ID
@@ -259,6 +269,17 @@ public function setCategoryId($categoryId)
     {
         return $this->setData(self::CATEGORY_ID, $categoryId);
     }
+
+    /**
+     * Set use subcategories
+     *
+     * @param int $useSubcategories
+     * @return ItemInterface
+     */
+    public function setUseSubcategories($useSubcategories)
+    {
+        return $this->setData(self::USE_SUBCATEGORIES, $useSubcategories);
+    }
 
     /**
      * Set page ID

Setup/InstallSchema.php

@@ -10,6 +10,9 @@
 
 class InstallSchema implements InstallSchemaInterface
 {
+    /**
+     * {@inheritdoc}
+     */
     public function install(SchemaSetupInterface $setup, ModuleContextInterface $context)
     {
         $installer = $setup;

Setup/UpgradeSchema.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace OuterEdge\Menu\Setup;
+
+use Magento\Framework\Setup\UpgradeSchemaInterface;
+use Magento\Framework\Setup\ModuleContextInterface;
+use Magento\Framework\Setup\SchemaSetupInterface;
+use Magento\Framework\DB\Ddl\Table;
+
+class UpgradeSchema implements UpgradeSchemaInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function upgrade(SchemaSetupInterface $setup, ModuleContextInterface $context)
+    {
+        $setup->startSetup();
+
+        if (version_compare($context->getVersion(), '1.0.1', '<')) {
+            $this->addUseSubcategoriesColumnToItemTable($setup);
+        }
+
+        $setup->endSetup();
+    }
+
+    /**
+     * Add the column 'use_subcategories' to the MenuItem table
+     * It allows to use subcategory tree on a menu item
+     *
+     * @param SchemaSetupInterface $setup
+     *
+     * @return void
+     */
+    private function addUseSubcategoriesColumnToItemTable(SchemaSetupInterface $setup)
+    {
+        $connection = $setup->getConnection();
+
+        $tableItem = $setup->getTable('menu_item');
+        if ($connection->isTableExists($tableItem) == true) {
+            $connection->addColumn(
+                $tableItem,
+                'use_subcategories',
+                [
+                    'type'     => Table::TYPE_SMALLINT,
+                    'nullable' => false,
+                    'default'  => 0,
+                    'comment'  => 'Use Subcategory Tree'
+                ]
+            );
+        }
+    }
+}

etc/module.xml

@@ -1,4 +1,4 @@
 <?xml version="1.0"?>
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
-    <module name="OuterEdge_Menu" setup_version="1.0.0"/>
+    <module name="OuterEdge_Menu" setup_version="1.0.1"/>
 </config>