MAGE-817 Updated deprecated registry code from backend

mohitalgolia · mohitalgolia · commit 155cf84d7be7 · 2024-01-12T20:13:10.000+05:30
diff --git a/Block/Adminhtml/Category/Merchandising.php b/Block/Adminhtml/Category/Merchandising.php
@@ -6,15 +6,15 @@
 use Algolia\AlgoliaSearch\Helper\Data;
 use Magento\Backend\Block\Template\Context;
 use Magento\Catalog\Model\Category;
-use Magento\Framework\Registry;
+use Algolia\AlgoliaSearch\Registry\CurrentCategory;
 
 class Merchandising extends \Magento\Backend\Block\Template
 {
     /** @var string */
     protected $_template = 'catalog/category/edit/merchandising.phtml';
 
-    /** @var Registry */
-    protected $registry;
+    /** @var CurrentCategory */
+    protected $currentCategory;
 
     /** @var ConfigHelper */
     private $configHelper;
@@ -27,19 +27,19 @@ class Merchandising extends \Magento\Backend\Block\Template
 
     /**
      * @param Context $context
-     * @param Registry $registry
+     * @param CurrentCategory $currentCategory
      * @param ConfigHelper $configHelper
      * @param Data $coreHelper
      * @param array $data
      */
     public function __construct(
         Context $context,
-        Registry $registry,
+        CurrentCategory $currentCategory,
         ConfigHelper $configHelper,
         Data $coreHelper,
         array $data = []
     ) {
-        $this->registry = $registry;
+        $this->currentCategory = $currentCategory;
         $this->configHelper = $configHelper;
         $this->coreHelper = $coreHelper;
         $this->storeManager = $context->getStoreManager();
@@ -50,7 +50,7 @@ public function __construct(
     /** @return Category | null */
     public function getCategory()
     {
-        return $this->registry->registry('category');
+        return $this->currentCategory->get();
     }
 
     /** @return bool */
diff --git a/Block/Adminhtml/LandingPage/SearchConfiguration.php b/Block/Adminhtml/LandingPage/SearchConfiguration.php
@@ -6,15 +6,15 @@
 use Algolia\AlgoliaSearch\Helper\Data;
 use Algolia\AlgoliaSearch\Model\LandingPage;
 use Magento\Backend\Block\Template\Context;
-use Magento\Framework\Registry;
+use Magento\Backend\Model\Session;
 
 class SearchConfiguration extends \Magento\Backend\Block\Template
 {
     /** @var string */
     protected $_template = 'landingpage/search-configuration.phtml';
 
-    /** @var Registry */
-    protected $registry;
+    /** @var Session */
+    protected $backendSession;
 
     /** @var ConfigHelper */
     private $configHelper;
@@ -27,19 +27,19 @@ class SearchConfiguration extends \Magento\Backend\Block\Template
 
     /**
      * @param Context $context
-     * @param Registry $registry
+     * @param Session $backendSession
      * @param ConfigHelper $configHelper
      * @param Data $coreHelper
      * @param array $data
      */
     public function __construct(
         Context $context,
-        Registry $registry,
+        Session $backendSession,
         ConfigHelper $configHelper,
         Data $coreHelper,
         array $data = []
     ) {
-        $this->registry = $registry;
+        $this->backendSession = $backendSession;
         $this->configHelper = $configHelper;
         $this->coreHelper = $coreHelper;
 
@@ -49,7 +49,7 @@ public function __construct(
     /** @return LandingPage | null */
     public function getLandingPage()
     {
-        return $this->registry->registry('algoliasearch_landing_page');
+        return $this->backendSession->getData('algoliasearch_landing_page');
     }
 
     /** @return ConfigHelper */
diff --git a/Block/Adminhtml/Query/Merchandising.php b/Block/Adminhtml/Query/Merchandising.php
@@ -6,15 +6,15 @@
 use Algolia\AlgoliaSearch\Helper\Data;
 use Algolia\AlgoliaSearch\Model\Query;
 use Magento\Backend\Block\Template\Context;
-use Magento\Framework\Registry;
+use Magento\Backend\Model\Session;
 
 class Merchandising extends \Magento\Backend\Block\Template
 {
     /** @var string */
     protected $_template = 'query/edit/merchandising.phtml';
 
-    /** @var Registry */
-    protected $registry;
+    /** @var Session */
+    protected $backendSession;
 
     /** @var ConfigHelper */
     private $configHelper;
@@ -27,19 +27,19 @@ class Merchandising extends \Magento\Backend\Block\Template
 
     /**
      * @param Context $context
-     * @param Registry $registry
+     * @param Session $backendSession
      * @param ConfigHelper $configHelper
      * @param Data $coreHelper
      * @param array $data
      */
     public function __construct(
         Context $context,
-        Registry $registry,
+        Session $backendSession,
         ConfigHelper $configHelper,
         Data $coreHelper,
         array $data = []
     ) {
-        $this->registry = $registry;
+        $this->backendSession = $backendSession;
         $this->configHelper = $configHelper;
         $this->coreHelper = $coreHelper;
         $this->storeManager = $context->getStoreManager();
@@ -50,7 +50,7 @@ public function __construct(
     /** @return Query | null */
     public function getCurrentQuery()
     {
-        return $this->registry->registry('algoliasearch_query');
+        return $this->backendSession->getData('algoliasearch_query');
     }
 
     /** @return ConfigHelper */
diff --git a/Block/RecommendProductView.php b/Block/RecommendProductView.php
@@ -8,7 +8,7 @@
 
 use Magento\Catalog\Model\Product;
 use Algolia\AlgoliaSearch\Helper\ConfigHelper;
-use Magento\Framework\Registry;
+use Algolia\AlgoliaSearch\Registry\CurrentProduct;
 use Magento\Framework\View\Element\Template;
 use Magento\Framework\View\Element\Template\Context;
 
@@ -20,11 +20,9 @@ class RecommendProductView extends Template
     protected $product = null;
 
     /**
-     * Core registry
-     *
-     * @var Registry
+     * @var CurrentProduct
      */
-    protected $coreRegistry = null;
+    protected $currentProduct;
 
     /**
      * @var ConfigHelper
@@ -33,17 +31,17 @@ class RecommendProductView extends Template
 
     /**
      * @param Context $context
-     * @param Registry $registry
+     * @param CurrentProduct $currentProduct
      * @param ConfigHelper $configHelper
      * @param array $data
      */
     public function __construct(
         Context      $context,
-        Registry     $registry,
+        CurrentProduct     $currentProduct,
         ConfigHelper $configHelper,
         array        $data = []
     ) {
-        $this->coreRegistry = $registry;
+        $this->currentProduct = $currentProduct;
         $this->configHelper = $configHelper;
         parent::__construct($context, $data);
     }
@@ -56,7 +54,7 @@ public function __construct(
     public function getProduct()
     {
         if (!$this->product) {
-            $this->product = $this->coreRegistry->registry('product');
+            $this->product = $this->currentProduct->get();
         }
         return $this->product;
     }
diff --git a/Controller/Adminhtml/Landingpage/AbstractAction.php b/Controller/Adminhtml/Landingpage/AbstractAction.php
@@ -5,13 +5,14 @@
 use Algolia\AlgoliaSearch\Helper\MerchandisingHelper;
 use Algolia\AlgoliaSearch\Model\LandingPageFactory;
 use Magento\Backend\App\Action\Context;
-use Magento\Framework\Registry;
+use Magento\Backend\Model\Session;
 use Magento\Store\Model\StoreManagerInterface;
 
 abstract class AbstractAction extends \Magento\Backend\App\Action
 {
-    /** @var Registry */
-    protected $coreRegistry;
+
+    /** @var Session */
+    protected $backendSession;
 
     /** @var LandingPageFactory */
     protected $landingPageFactory;
@@ -24,21 +25,21 @@ abstract class AbstractAction extends \Magento\Backend\App\Action
 
     /**
      * @param Context $context
-     * @param Registry $coreRegistry
+     * @param Session $backendSession
      * @param LandingPageFactory $landingPageFactory
      * @param MerchandisingHelper $merchandisingHelper
      * @param StoreManagerInterface $storeManager
      */
     public function __construct(
         Context $context,
-        Registry $coreRegistry,
+        Session $backendSession,
         LandingPageFactory $landingPageFactory,
         MerchandisingHelper $merchandisingHelper,
         StoreManagerInterface $storeManager
     ) {
         parent::__construct($context);
 
-        $this->coreRegistry = $coreRegistry;
+        $this->backendSession = $backendSession;
         $this->landingPageFactory = $landingPageFactory;
         $this->merchandisingHelper = $merchandisingHelper;
         $this->storeManager = $storeManager;
@@ -65,7 +66,7 @@ protected function initLandingPage()
             }
         }
 
-        $this->coreRegistry->register('algoliasearch_landing_page', $landingPage);
+        $this->backendSession->setData('algoliasearch_landing_page', $landingPage);
 
         return $landingPage;
     }
diff --git a/Controller/Adminhtml/Landingpage/Duplicate.php b/Controller/Adminhtml/Landingpage/Duplicate.php
@@ -35,8 +35,7 @@ public function execute()
         try {
             $newLandingPage->getResource()->save($newLandingPage);
             $this->copyQueryRules($landingPage->getId(), $newLandingPage->getId());
-
-            $this->coreRegistry->register('algoliasearch_landing_page', $newLandingPage);
+            $this->backendSession->setData('algoliasearch_landing_page', $newLandingPage);
             $this->messageManager->addSuccessMessage(__('The duplicated landing page has been saved.'));
 
             return $resultRedirect->setPath('*/*/edit', ['id' => $newLandingPage->getId()]);
diff --git a/Controller/Adminhtml/Landingpage/Save.php b/Controller/Adminhtml/Landingpage/Save.php
@@ -5,6 +5,7 @@
 use Algolia\AlgoliaSearch\Helper\ConfigHelper;
 use Algolia\AlgoliaSearch\Helper\MerchandisingHelper;
 use Algolia\AlgoliaSearch\Model\LandingPageFactory;
+use Magento\Backend\Model\Session;
 use Magento\Framework\App\Request\DataPersistorInterface;
 use Magento\Framework\Controller\ResultFactory;
 use Magento\Framework\Exception\LocalizedException;
@@ -32,7 +33,7 @@ class Save extends AbstractAction
      * PHP Constructor
      *
      * @param \Magento\Backend\App\Action\Context $context
-     * @param \Magento\Framework\Registry $coreRegistry
+     * @param Session $backendSession
      * @param LandingPageFactory $landingPageFactory
      * @param MerchandisingHelper $merchandisingHelper
      * @param StoreManagerInterface $storeManager
@@ -42,7 +43,7 @@ class Save extends AbstractAction
      */
     public function __construct(
         \Magento\Backend\App\Action\Context $context,
-        \Magento\Framework\Registry $coreRegistry,
+        Session $backendSession,
         LandingPageFactory $landingPageFactory,
         MerchandisingHelper $merchandisingHelper,
         StoreManagerInterface $storeManager,
@@ -55,7 +56,7 @@ public function __construct(
         $this->configHelper = $configHelper;
         parent::__construct(
             $context,
-            $coreRegistry,
+            $backendSession,
             $landingPageFactory,
             $merchandisingHelper,
             $storeManager
diff --git a/Controller/Adminhtml/Query/AbstractAction.php b/Controller/Adminhtml/Query/AbstractAction.php
@@ -5,13 +5,13 @@
 use Algolia\AlgoliaSearch\Helper\MerchandisingHelper;
 use Algolia\AlgoliaSearch\Model\QueryFactory;
 use Magento\Backend\App\Action\Context;
-use Magento\Framework\Registry;
+use Magento\Backend\Model\Session;
 use Magento\Store\Model\StoreManagerInterface;
 
 abstract class AbstractAction extends \Magento\Backend\App\Action
 {
-    /** @var Registry */
-    protected $coreRegistry;
+    /** @var Session */
+    protected $backendSession;
 
     /** @var QueryFactory */
     protected $queryFactory;
@@ -24,21 +24,21 @@ abstract class AbstractAction extends \Magento\Backend\App\Action
 
     /**
      * @param Context $context
-     * @param Registry $coreRegistry
+     * @param Session $backendSession
      * @param QueryFactory $queryFactory
      * @param MerchandisingHelper $merchandisingHelper
      * @param StoreManagerInterface $storeManager
      */
     public function __construct(
         Context $context,
-        Registry $coreRegistry,
+        Session $backendSession,
         QueryFactory $queryFactory,
         MerchandisingHelper $merchandisingHelper,
         StoreManagerInterface $storeManager
     ) {
         parent::__construct($context);
 
-        $this->coreRegistry = $coreRegistry;
+        $this->backendSession = $backendSession;
         $this->queryFactory = $queryFactory;
         $this->merchandisingHelper = $merchandisingHelper;
         $this->storeManager = $storeManager;
@@ -65,7 +65,7 @@ protected function initQuery()
             }
         }
 
-        $this->coreRegistry->register('algoliasearch_query', $query);
+        $this->backendSession->setData('algoliasearch_query', $query);
 
         return $query;
     }
diff --git a/Controller/Adminhtml/Query/Save.php b/Controller/Adminhtml/Query/Save.php
@@ -6,6 +6,7 @@
 use Algolia\AlgoliaSearch\Helper\MerchandisingHelper;
 use Algolia\AlgoliaSearch\Model\ImageUploader;
 use Algolia\AlgoliaSearch\Model\QueryFactory;
+use Magento\Backend\Model\Session;
 use Magento\Framework\App\Request\DataPersistorInterface;
 use Magento\Framework\Controller\ResultFactory;
 use Magento\Framework\Exception\LocalizedException;
@@ -32,7 +33,7 @@ class Save extends AbstractAction
      * PHP Constructor
      *
      * @param \Magento\Backend\App\Action\Context $context
-     * @param \Magento\Framework\Registry $coreRegistry
+     * @param Session $backendSession
      * @param QueryFactory $queryFactory
      * @param MerchandisingHelper $merchandisingHelper
      * @param StoreManagerInterface $storeManager
@@ -44,7 +45,7 @@ class Save extends AbstractAction
      */
     public function __construct(
         \Magento\Backend\App\Action\Context $context,
-        \Magento\Framework\Registry $coreRegistry,
+        Session $backendSession,
         QueryFactory $queryFactory,
         MerchandisingHelper $merchandisingHelper,
         StoreManagerInterface $storeManager,
@@ -58,7 +59,7 @@ public function __construct(
 
         parent::__construct(
             $context,
-            $coreRegistry,
+            $backendSession,
             $queryFactory,
             $merchandisingHelper,
             $storeManager
diff --git a/etc/adminhtml/events.xml b/etc/adminhtml/events.xml
@@ -65,5 +65,7 @@
     <event name="sales_order_shipment_save_after">
         <observer name="algoliasearch_reindex_product_on_last_item_purchase" instance="Algolia\AlgoliaSearch\Observer\ReindexProductOnLastItemPurchase"/>
     </event>
-
+    <event name="catalog_controller_category_init_after">
+        <observer name="algoliasearch_current_category" instance="Algolia\AlgoliaSearch\Observer\RegisterCurrentCategoryObserver"/>
+    </event>
 </config>
