ENGCOM-6942: ObjectManager cleanup - Remove usage from AdminNotificat…

…ion module #26939
magento · Mar 6, 2020 · 51755fd · 51755fd
2 parents 31c4ce6 + 480f8ab
commit 51755fd
Show file tree

Hide file tree

Showing 8 changed files with 161 additions and 72 deletions.
diff --git a/app/code/Magento/AdminNotification/Block/System/Messages.php b/app/code/Magento/AdminNotification/Block/System/Messages.php
@@ -5,45 +5,54 @@
  */
 namespace Magento\AdminNotification\Block\System;
 
-class Messages extends \Magento\Backend\Block\Template
+use Magento\AdminNotification\Model\ResourceModel\System\Message\Collection\Synchronized;
+use Magento\Backend\Block\Template;
+use Magento\Backend\Block\Template\Context as TemplateContext;
+use Magento\Framework\Json\Helper\Data as JsonDataHelper;
+use Magento\Framework\Notification\MessageInterface;
+use Magento\Framework\Serialize\Serializer\Json as JsonSerializer;
+
+/**
+ * AdminNotification Messages class
+ */
+class Messages extends Template
 {
     /**
-     * Message list
+     * Synchronized Message collection
      *
-     * @var \Magento\AdminNotification\Model\ResourceModel\System\Message\Collection\Synchronized
+     * @var Synchronized
      */
     protected $_messages;
 
     /**
-     * @var \Magento\Framework\Json\Helper\Data
+     * @var JsonDataHelper
      * @deprecated
      */
     protected $jsonHelper;
 
     /**
-     * @var \Magento\Framework\Serialize\Serializer\Json
+     * @var JsonSerializer
      */
     private $serializer;
 
     /**
-     * @param \Magento\Backend\Block\Template\Context $context
-     * @param \Magento\AdminNotification\Model\ResourceModel\System\Message\Collection\Synchronized $messages
-     * @param \Magento\Framework\Json\Helper\Data $jsonHelper
+     * @param TemplateContext $context
+     * @param Synchronized $messages
+     * @param JsonDataHelper $jsonHelper
+     * @param JsonSerializer $serializer
      * @param array $data
-     * @param \Magento\Framework\Serialize\Serializer\Json|null $serializer
      */
     public function __construct(
-        \Magento\Backend\Block\Template\Context $context,
-        \Magento\AdminNotification\Model\ResourceModel\System\Message\Collection\Synchronized $messages,
-        \Magento\Framework\Json\Helper\Data $jsonHelper,
-        array $data = [],
-        \Magento\Framework\Serialize\Serializer\Json $serializer = null
+        TemplateContext $context,
+        Synchronized $messages,
+        JsonDataHelper $jsonHelper,
+        JsonSerializer $serializer,
+        array $data = []
     ) {
         $this->jsonHelper = $jsonHelper;
         parent::__construct($context, $data);
         $this->_messages = $messages;
-        $this->serializer = $serializer ?: \Magento\Framework\App\ObjectManager::getInstance()
-            ->get(\Magento\Framework\Serialize\Serializer\Json::class);
+        $this->serializer = $serializer;
     }
 
     /**
@@ -62,16 +71,14 @@ protected function _toHtml()
     /**
      * Retrieve message list
      *
-     * @return \Magento\Framework\Notification\MessageInterface[]
+     * @return MessageInterface[]|null
      */
     public function getLastCritical()
     {
         $items = array_values($this->_messages->getItems());
-        if (isset(
-            $items[0]
-        ) && $items[0]->getSeverity() == \Magento\Framework\Notification\MessageInterface::SEVERITY_CRITICAL
-        ) {
-            return $items[0];
+
+        if (!empty($items) && current($items)->getSeverity() === MessageInterface::SEVERITY_CRITICAL) {
+            return current($items);
         }
         return null;
     }
@@ -83,9 +90,7 @@ public function getLastCritical()
      */
     public function getCriticalCount()
     {
-        return $this->_messages->getCountBySeverity(
-            \Magento\Framework\Notification\MessageInterface::SEVERITY_CRITICAL
-        );
+        return $this->_messages->getCountBySeverity(MessageInterface::SEVERITY_CRITICAL);
     }
 
     /**
@@ -95,9 +100,7 @@ public function getCriticalCount()
      */
     public function getMajorCount()
     {
-        return $this->_messages->getCountBySeverity(
-            \Magento\Framework\Notification\MessageInterface::SEVERITY_MAJOR
-        );
+        return $this->_messages->getCountBySeverity(MessageInterface::SEVERITY_MAJOR);
     }
 
     /**

diff --git a/app/code/Magento/AdminNotification/Controller/Adminhtml/Notification/AjaxMarkAsRead.php b/app/code/Magento/AdminNotification/Controller/Adminhtml/Notification/AjaxMarkAsRead.php
@@ -1,33 +1,34 @@
 <?php
 /**
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\AdminNotification\Controller\Adminhtml\Notification;
 
+use Magento\AdminNotification\Controller\Adminhtml\Notification;
+use Magento\AdminNotification\Model\NotificationService;
 use Magento\Backend\App\Action;
+use Magento\Framework\App\Action\HttpPostActionInterface;
 use Magento\Framework\Controller\ResultFactory;
 
-class AjaxMarkAsRead extends \Magento\AdminNotification\Controller\Adminhtml\Notification
+/**
+ * AdminNotification AjaxMarkAsRead controller
+ */
+class AjaxMarkAsRead extends Notification implements HttpPostActionInterface
 {
     /**
-     * @var \Magento\AdminNotification\Model\NotificationService
+     * @var NotificationService
      */
     private $notificationService;
 
     /**
      * @param Action\Context $context
-     * @param \Magento\AdminNotification\Model\NotificationService|null $notificationService
-     * @throws \RuntimeException
+     * @param NotificationService $notificationService
      */
-    public function __construct(
-        Action\Context $context,
-        \Magento\AdminNotification\Model\NotificationService $notificationService = null
-    ) {
+    public function __construct(Action\Context $context, NotificationService $notificationService)
+    {
         parent::__construct($context);
-        $this->notificationService = $notificationService?: \Magento\Framework\App\ObjectManager::getInstance()
-            ->get(\Magento\AdminNotification\Model\NotificationService::class);
+        $this->notificationService = $notificationService;
     }
 
     /**

diff --git a/app/code/Magento/AdminNotification/Controller/Adminhtml/Notification/MarkAsRead.php b/app/code/Magento/AdminNotification/Controller/Adminhtml/Notification/MarkAsRead.php
@@ -1,12 +1,20 @@
 <?php
 /**
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\AdminNotification\Controller\Adminhtml\Notification;
 
-class MarkAsRead extends \Magento\AdminNotification\Controller\Adminhtml\Notification
+use Magento\AdminNotification\Controller\Adminhtml\Notification;
+use Magento\AdminNotification\Model\NotificationService;
+use Magento\Backend\App\Action;
+use Magento\Framework\App\Action\HttpGetActionInterface;
+use Magento\Framework\Exception\LocalizedException;
+
+/**
+ * AdminNotification MarkAsRead controller
+ */
+class MarkAsRead extends Notification implements HttpGetActionInterface
 {
     /**
      * Authorization level of a basic admin session
@@ -16,20 +24,31 @@ class MarkAsRead extends \Magento\AdminNotification\Controller\Adminhtml\Notific
     const ADMIN_RESOURCE = 'Magento_AdminNotification::mark_as_read';
 
     /**
-     * @return void
+     * @var NotificationService
+     */
+    private $notificationService;
+
+    /**
+     * @param Action\Context $context
+     * @param NotificationService $notificationService
+     */
+    public function __construct(Action\Context $context, NotificationService $notificationService)
+    {
+        parent::__construct($context);
+        $this->notificationService = $notificationService;
+    }
+
+    /**
+     * @inheritdoc
      */
     public function execute()
     {
         $notificationId = (int)$this->getRequest()->getParam('id');
         if ($notificationId) {
             try {
-                $this->_objectManager->create(
-                    \Magento\AdminNotification\Model\NotificationService::class
-                )->markAsRead(
-                    $notificationId
-                );
+                $this->notificationService->markAsRead($notificationId);
                 $this->messageManager->addSuccessMessage(__('The message has been marked as Read.'));
-            } catch (\Magento\Framework\Exception\LocalizedException $e) {
+            } catch (LocalizedException $e) {
                 $this->messageManager->addErrorMessage($e->getMessage());
             } catch (\Exception $e) {
                 $this->messageManager->addExceptionMessage(
@@ -38,9 +57,8 @@ public function execute()
                 );
             }
 
-            $this->getResponse()->setRedirect($this->_redirect->getRedirectUrl($this->getUrl('*')));
-            return;
+            return $this->getResponse()->setRedirect($this->_redirect->getRedirectUrl($this->getUrl('*')));
         }
-        $this->_redirect('adminhtml/*/');
+        return $this->_redirect('adminhtml/*/');
     }
 }
diff --git a/app/code/Magento/AdminNotification/Controller/Adminhtml/Notification/MassMarkAsRead.php b/app/code/Magento/AdminNotification/Controller/Adminhtml/Notification/MassMarkAsRead.php
@@ -1,14 +1,20 @@
 <?php
 /**
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\AdminNotification\Controller\Adminhtml\Notification;
 
-class MassMarkAsRead extends \Magento\AdminNotification\Controller\Adminhtml\Notification
-{
+use Magento\AdminNotification\Controller\Adminhtml\Notification;
+use Magento\AdminNotification\Model\InboxFactory as InboxModelFactory;
+use Magento\Backend\App\Action;
+use Magento\Framework\App\Action\HttpPostActionInterface;
 
+/**
+ * AdminNotification MassMarkAsRead controller
+ */
+class MassMarkAsRead extends Notification implements HttpPostActionInterface
+{
     /**
      * Authorization level of a basic admin session
      *
@@ -17,7 +23,22 @@ class MassMarkAsRead extends \Magento\AdminNotification\Controller\Adminhtml\Not
     const ADMIN_RESOURCE = 'Magento_AdminNotification::mark_as_read';
 
     /**
-     * @return void
+     * @var InboxModelFactory
+     */
+    private $inboxModelFactory;
+
+    /**
+     * @param Action\Context $context
+     * @param InboxModelFactory $inboxModelFactory
+     */
+    public function __construct(Action\Context $context, InboxModelFactory $inboxModelFactory)
+    {
+        parent::__construct($context);
+        $this->inboxModelFactory = $inboxModelFactory;
+    }
+
+    /**
+     * @inheritdoc
      */
     public function execute()
     {
@@ -27,7 +48,7 @@ public function execute()
         } else {
             try {
                 foreach ($ids as $id) {
-                    $model = $this->_objectManager->create(\Magento\AdminNotification\Model\Inbox::class)->load($id);
+                    $model = $this->inboxModelFactory->create()->load($id);
                     if ($model->getId()) {
                         $model->setIsRead(1)->save();
                     }
@@ -44,6 +65,6 @@ public function execute()
                 );
             }
         }
-        $this->_redirect('adminhtml/*/');
+        return $this->_redirect('adminhtml/*/');
     }
 }
diff --git a/app/code/Magento/AdminNotification/Controller/Adminhtml/Notification/MassRemove.php b/app/code/Magento/AdminNotification/Controller/Adminhtml/Notification/MassRemove.php
@@ -1,12 +1,19 @@
 <?php
 /**
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\AdminNotification\Controller\Adminhtml\Notification;
 
-class MassRemove extends \Magento\AdminNotification\Controller\Adminhtml\Notification
+use Magento\AdminNotification\Controller\Adminhtml\Notification;
+use Magento\AdminNotification\Model\InboxFactory as InboxModelFactory;
+use Magento\Backend\App\Action;
+use Magento\Framework\App\Action\HttpPostActionInterface;
+
+/**
+ * AdminNotification MassRemove controller
+ */
+class MassRemove extends Notification implements HttpPostActionInterface
 {
 
     /**
@@ -15,9 +22,23 @@ class MassRemove extends \Magento\AdminNotification\Controller\Adminhtml\Notific
      * @see _isAllowed()
      */
     const ADMIN_RESOURCE = 'Magento_AdminNotification::adminnotification_remove';
+    /**
+     * @var InboxModelFactory
+     */
+    private $inboxModelFactory;
+
+    /**
+     * @param Action\Context $context
+     * @param InboxModelFactory $inboxModelFactory
+     */
+    public function __construct(Action\Context $context, InboxModelFactory $inboxModelFactory)
+    {
+        parent::__construct($context);
+        $this->inboxModelFactory = $inboxModelFactory;
+    }
 
     /**
-     * @return void
+     * @inheritdoc
      */
     public function execute()
     {
@@ -27,7 +48,7 @@ public function execute()
         } else {
             try {
                 foreach ($ids as $id) {
-                    $model = $this->_objectManager->create(\Magento\AdminNotification\Model\Inbox::class)->load($id);
+                    $model = $this->inboxModelFactory->create()->load($id);
                     if ($model->getId()) {
                         $model->setIsRemove(1)->save();
                     }
@@ -42,6 +63,6 @@ public function execute()
                 );
             }
         }
-        $this->_redirect('adminhtml/*/');
+        return $this->_redirect('adminhtml/*/');
     }
 }