MAGETWO-62855: Year Copyright

Author: Sergii Kovalenko

app/code/Magento/Backend/Model/Menu.php

@@ -5,6 +5,12 @@
  */
 namespace Magento\Backend\Model;
 
+use Magento\Backend\Model\Menu\Item;
+use Magento\Backend\Model\Menu\Item\Factory;
+use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Serialize\SerializerInterface;
+use Psr\Log\LoggerInterface;
+
 /**
  * Backend menu model
  */
@@ -18,33 +24,54 @@ class Menu extends \ArrayObject
     protected $_path = '';
 
     /**
-     * @var \Psr\Log\LoggerInterface
+     * @var LoggerInterface
      */
     protected $_logger;
 
     /**
-     * @param \Psr\Log\LoggerInterface $logger
+     * @var Factory
+     */
+    private $menuItemFactory;
+
+    /**
+     * @var SerializerInterface
+     */
+    private $serializer;
+
+    /**
+     * Menu constructor
+     *
+     * @param LoggerInterface $logger
      * @param string $pathInMenuStructure
+     * @param Factory|null $menuItemFactory
+     * @param SerializerInterface|null $serializer
      */
-    public function __construct(\Psr\Log\LoggerInterface $logger, $pathInMenuStructure = '')
-    {
+    public function __construct(
+        LoggerInterface $logger,
+        $pathInMenuStructure = '',
+        Factory $menuItemFactory = null,
+        SerializerInterface $serializer = null
+    ) {
         if ($pathInMenuStructure) {
             $this->_path = $pathInMenuStructure . '/';
         }
         $this->_logger = $logger;
         $this->setIteratorClass(\Magento\Backend\Model\Menu\Iterator::class);
+        $this->menuItemFactory = $menuItemFactory ?: ObjectManager::getInstance()
+            ->create(Factory::class);
+        $this->serializer = $serializer ?: ObjectManager::getInstance()->create(SerializerInterface::class);
     }
 
     /**
      * Add child to menu item
      *
-     * @param \Magento\Backend\Model\Menu\Item $item
+     * @param Item $item
      * @param string $parentId
      * @param int $index
      * @return void
      * @throws \InvalidArgumentException
      */
-    public function add(\Magento\Backend\Model\Menu\Item $item, $parentId = null, $index = null)
+    public function add(Item $item, $parentId = null, $index = null)
     {
         if ($parentId !== null) {
             $parentItem = $this->get($parentId);
@@ -69,13 +96,13 @@ public function add(\Magento\Backend\Model\Menu\Item $item, $parentId = null, $i
      * Retrieve menu item by id
      *
      * @param string $itemId
-     * @return \Magento\Backend\Model\Menu\Item|null
+     * @return Item|null
      */
     public function get($itemId)
     {
         $result = null;
+        /** @var Item $item */
         foreach ($this as $item) {
-            /** @var $item \Magento\Backend\Model\Menu\Item */
             if ($item->getId() == $itemId) {
                 $result = $item;
                 break;
@@ -116,8 +143,8 @@ public function move($itemId, $toItemId, $sortIndex = null)
     public function remove($itemId)
     {
         $result = false;
+        /** @var Item $item */
         foreach ($this as $key => $item) {
-            /** @var $item \Magento\Backend\Model\Menu\Item */
             if ($item->getId() == $itemId) {
                 unset($this[$key]);
                 $result = true;
@@ -144,8 +171,8 @@ public function remove($itemId)
     public function reorder($itemId, $position)
     {
         $result = false;
+        /** @var Item $item */
         foreach ($this as $key => $item) {
-            /** @var $item \Magento\Backend\Model\Menu\Item */
             if ($item->getId() == $itemId) {
                 unset($this[$key]);
                 $this->add($item, null, $position);
@@ -161,23 +188,23 @@ public function reorder($itemId, $position)
     /**
      * Check whether provided item is last in list
      *
-     * @param \Magento\Backend\Model\Menu\Item $item
+     * @param Item $item
      * @return bool
      */
-    public function isLast(\Magento\Backend\Model\Menu\Item $item)
+    public function isLast(Item $item)
     {
         return $this->offsetGet(max(array_keys($this->getArrayCopy())))->getId() == $item->getId();
     }
 
     /**
      * Find first menu item that user is able to access
      *
-     * @return \Magento\Backend\Model\Menu\Item|null
+     * @return Item|null
      */
     public function getFirstAvailable()
     {
         $result = null;
-        /** @var $item \Magento\Backend\Model\Menu\Item */
+        /** @var Item $item */
         foreach ($this as $item) {
             if ($item->isAllowed() && !$item->isDisabled()) {
                 if ($item->hasChildren()) {
@@ -198,7 +225,7 @@ public function getFirstAvailable()
      * Get parent items by item id
      *
      * @param string $itemId
-     * @return \Magento\Backend\Model\Menu\Item[]
+     * @return Item[]
      */
     public function getParentItems($itemId)
     {
@@ -217,8 +244,8 @@ public function getParentItems($itemId)
      */
     protected function _findParentItems($menu, $itemId, &$parents)
     {
+        /** @var Item $item */
         foreach ($menu as $item) {
-            /** @var $item \Magento\Backend\Model\Menu\Item */
             if ($item->getId() == $itemId) {
                 return true;
             }
@@ -233,16 +260,54 @@ protected function _findParentItems($menu, $itemId, &$parents)
     }
 
     /**
-     * Hack to unset logger instance which cannot be serialized
+     * Serialize menu
      *
      * @return string
      */
     public function serialize()
     {
-        $logger = $this->_logger;
-        unset($this->_logger);
-        $result = parent::serialize();
-        $this->_logger = $logger;
-        return $result;
+        return $this->serializer->serialize($this->toArray());
+    }
+
+    /**
+     * Get menu data represented as an array
+     *
+     * @return array
+     */
+    public function toArray()
+    {
+        $data = [];
+        foreach ($this as $item) {
+            $data[] = $item->toArray();
+        }
+        return $data;
+    }
+
+    /**
+     * Unserialize menu
+     *
+     * @param string $serialized
+     * @return void
+     */
+    public function unserialize($serialized)
+    {
+        $data = $this->serializer->unserialize($serialized);
+        $this->populateFromArray($data);
+    }
+
+    /**
+     * Populate the menu with data from array
+     *
+     * @param array $data
+     * @return void
+     */
+    public function populateFromArray(array $data)
+    {
+        $items = [];
+        foreach ($data as $itemData) {
+            $item = $this->menuItemFactory->create($itemData);
+            $items[] = $item;
+        }
+        $this->exchangeArray($items);
     }
 }

app/code/Magento/Backend/Model/Menu/Item.php

@@ -4,10 +4,11 @@
  * See COPYING.txt for license details.
  */
 
-// @codingStandardsIgnoreFile
-
 namespace Magento\Backend\Model\Menu;
 
+use Magento\Backend\Model\Menu;
+use Magento\Store\Model\ScopeInterface;
+
 /**
  * Menu item. Should be used to create nested menu structures with \Magento\Backend\Model\Menu
  *
@@ -102,7 +103,7 @@ class Item
     /**
      * Submenu item list
      *
-     * @var \Magento\Backend\Model\Menu
+     * @var Menu
      */
     protected $_submenu;
 
@@ -130,6 +131,7 @@ class Item
      * Serialized submenu string
      *
      * @var string
+     * @deprecated
      */
     protected $_serializedSubmenu;
 
@@ -167,22 +169,13 @@ public function __construct(
     ) {
         $this->_validator = $validator;
         $this->_validator->validate($data);
-
         $this->_moduleManager = $moduleManager;
         $this->_acl = $authorization;
         $this->_scopeConfig = $scopeConfig;
         $this->_menuFactory = $menuFactory;
         $this->_urlModel = $urlModel;
-        $this->_moduleName = isset($data['module']) ? $data['module'] : 'Magento_Backend';
         $this->_moduleList = $moduleList;
-
-        $this->_id = $data['id'];
-        $this->_title = $data['title'];
-        $this->_action = $this->_getArgument($data, 'action');
-        $this->_resource = $this->_getArgument($data, 'resource');
-        $this->_dependsOnModule = $this->_getArgument($data, 'dependsOnModule');
-        $this->_dependsOnConfig = $this->_getArgument($data, 'dependsOnConfig');
-        $this->_tooltip = $this->_getArgument($data, 'toolTip', '');
+        $this->populateFromArray($data);
     }
 
     /**
@@ -215,13 +208,13 @@ public function getId()
      */
     public function hasChildren()
     {
-        return !is_null($this->_submenu) && (bool)$this->_submenu->count();
+        return (null !== $this->_submenu) && (bool)$this->_submenu->count();
     }
 
     /**
      * Retrieve submenu
      *
-     * @return \Magento\Backend\Model\Menu
+     * @return Menu
      */
     public function getChildren()
     {
@@ -425,7 +418,7 @@ protected function _isModuleDependenciesAvailable()
     protected function _isConfigDependenciesAvailable()
     {
         if ($this->_dependsOnConfig) {
-            return $this->_scopeConfig->isSetFlag((string)$this->_dependsOnConfig, \Magento\Store\Model\ScopeInterface::SCOPE_STORE);
+            return $this->_scopeConfig->isSetFlag((string)$this->_dependsOnConfig, ScopeInterface::SCOPE_STORE);
         }
         return true;
     }
@@ -445,45 +438,53 @@ public function isAllowed()
     }
 
     /**
-     * @return string[]
+     * Get menu item data represented as an array
+     *
+     * @return array
      */
-    public function __sleep()
+    public function toArray()
     {
-        if ($this->_submenu) {
-            $this->_serializedSubmenu = $this->_submenu->serialize();
-        }
         return [
-            '_parentId',
-            '_moduleName',
-            '_sortIndex',
-            '_dependsOnConfig',
-            '_id',
-            '_resource',
-            '_path',
-            '_action',
-            '_dependsOnModule',
-            '_tooltip',
-            '_title',
-            '_serializedSubmenu'
+            'parent_id' => $this->_parentId,
+            'module_name' => $this->_moduleName,
+            'sort_index' => $this->_sortIndex,
+            'depends_on_config' => $this->_dependsOnConfig,
+            'id' => $this->_id,
+            'resource' => $this->_resource,
+            'path' => $this->_path,
+            'action' => $this->_action,
+            'depends_on_module' => $this->_dependsOnModule,
+            'tooltip' => $this->_tooltip,
+            'title' => $this->_title,
+            'sub_menu' => isset($this->_submenu) ? $this->_submenu->toArray() : null
         ];
     }
 
     /**
+     * Populate the menu item with data from array
+     *
+     * @param array $data
      * @return void
      */
-    public function __wakeup()
+    public function populateFromArray(array $data)
     {
-        $objectManager = \Magento\Framework\App\ObjectManager::getInstance();
-        $this->_moduleManager = $objectManager->get(\Magento\Framework\Module\Manager::class);
-        $this->_validator = $objectManager->get(\Magento\Backend\Model\Menu\Item\Validator::class);
-        $this->_acl = $objectManager->get(\Magento\Framework\AuthorizationInterface::class);
-        $this->_scopeConfig = $objectManager->get(\Magento\Framework\App\Config\ScopeConfigInterface::class);
-        $this->_menuFactory = $objectManager->get(\Magento\Backend\Model\MenuFactory::class);
-        $this->_urlModel = $objectManager->get(\Magento\Backend\Model\UrlInterface::class);
-        $this->_moduleList = $objectManager->get(\Magento\Framework\Module\ModuleListInterface::class);
-        if ($this->_serializedSubmenu) {
-            $this->_submenu = $this->_menuFactory->create();
-            $this->_submenu->unserialize($this->_serializedSubmenu);
+        $this->_parentId = $this->_getArgument($data, 'parent_id');
+        $this->_moduleName = $this->_getArgument($data, 'module_name', 'Magento_Backend');
+        $this->_sortIndex = $this->_getArgument($data, 'sort_index');
+        $this->_dependsOnConfig = $this->_getArgument($data, 'depends_on_config');
+        $this->_id = $this->_getArgument($data, 'id');
+        $this->_resource = $this->_getArgument($data, 'resource');
+        $this->_path = $this->_getArgument($data, 'path', '');
+        $this->_action = $this->_getArgument($data, 'action');
+        $this->_dependsOnModule = $this->_getArgument($data, 'depends_on_module');
+        $this->_tooltip = $this->_getArgument($data, 'tooltip', '');
+        $this->_title = $this->_getArgument($data, 'title');
+        if (isset($data['sub_menu'])) {
+            $menu = $this->_menuFactory->create();
+            $menu->populateFromArray($data['sub_menu']);
+            $this->_submenu = $menu;
+        } else {
+            $this->_submenu = null;
         }
     }
 }