MAGETWO-36105: Refactor controllers in the Persistent module

Author: Yuri Kovsher

app/code/Magento/Persistent/Controller/Index.php

@@ -5,54 +5,78 @@
  */
 namespace Magento\Persistent\Controller;
 
+use Magento\Framework\App\Action\Action;
+use Magento\Framework\App\Action\Context;
+use Magento\Persistent\Model\QuoteManager;
+use Magento\Checkout\Model\Session as CheckoutSession;
+use Magento\Customer\Model\Session as CustomerSession;
+use Magento\Persistent\Helper\Session as SessionHelper;
+use Magento\Framework\Controller\Result\RedirectFactory;
+
 /**
  * Persistent front controller
  */
-class Index extends \Magento\Framework\App\Action\Action
+class Index extends Action
 {
     /**
-     * Whether clear checkout session when logout
+     * Persistent observer
      *
-     * @var bool
+     * @var \Magento\Persistent\Model\Observer
      */
-    protected $_clearCheckoutSession = true;
+    protected $quoteManager;
+
+    /**
+     * Checkout session
+     *
+     * @var \Magento\Checkout\Model\Session
+     */
+    protected $checkoutSession;
 
     /**
      * Customer session
      *
      * @var \Magento\Customer\Model\Session
      */
-    protected $_customerSession;
+    protected $customerSession;
 
     /**
-     * Checkout session
-     *
-     * @var \Magento\Checkout\Model\Session
+     * @var \Magento\Persistent\Helper\Session
      */
-    protected $_checkoutSession;
+    protected $sessionHelper;
 
     /**
-     * Persistent observer
+     * @var \Magento\Framework\Controller\Result\RedirectFactory
+     */
+    protected $resultRedirectFactory;
+
+    /**
+     * Whether clear checkout session when logout
      *
-     * @var \Magento\Persistent\Model\Observer
+     * @var bool
      */
-    protected $quoteManager;
+    protected $clearCheckoutSession = true;
 
     /**
      * @param \Magento\Framework\App\Action\Context $context
      * @param \Magento\Persistent\Model\QuoteManager $quoteManager
      * @param \Magento\Checkout\Model\Session $checkoutSession
      * @param \Magento\Customer\Model\Session $customerSession
+     * @param \Magento\Persistent\Helper\Session $sessionHelper
+     * @param \Magento\Framework\Controller\Result\RedirectFactory $resultRedirectFactory
      */
     public function __construct(
-        \Magento\Framework\App\Action\Context $context,
-        \Magento\Persistent\Model\QuoteManager $quoteManager,
-        \Magento\Checkout\Model\Session $checkoutSession,
-        \Magento\Customer\Model\Session $customerSession
+        Context $context,
+        QuoteManager $quoteManager,
+        CheckoutSession $checkoutSession,
+        CustomerSession $customerSession,
+        SessionHelper $sessionHelper,
+        RedirectFactory $resultRedirectFactory
     ) {
         $this->quoteManager = $quoteManager;
-        $this->_checkoutSession = $checkoutSession;
-        $this->_customerSession = $customerSession;
+        $this->checkoutSession = $checkoutSession;
+        $this->customerSession = $customerSession;
+        $this->sessionHelper = $sessionHelper;
+        $this->resultRedirectFactory = $resultRedirectFactory;
         parent::__construct($context);
     }
 
@@ -64,17 +88,7 @@ public function __construct(
      */
     public function setClearCheckoutSession($clear = true)
     {
-        $this->_clearCheckoutSession = $clear;
+        $this->clearCheckoutSession = $clear;
         return $this;
     }
-
-    /**
-     * Retrieve 'persistent session' helper instance
-     *
-     * @return \Magento\Persistent\Helper\Session
-     */
-    protected function _getHelper()
-    {
-        return $this->_objectManager->get('Magento\Persistent\Helper\Session');
-    }
 }

app/code/Magento/Persistent/Controller/Index/ExpressCheckout.php

@@ -1,21 +1,24 @@
 <?php
 /**
- *
  * Copyright © 2015 Magento. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\Persistent\Controller\Index;
 
-class ExpressCheckout extends \Magento\Persistent\Controller\Index
+use Magento\Persistent\Controller\Index;
+
+class ExpressCheckout extends Index
 {
     /**
      * Add appropriate session message and redirect to shopping cart
      *
-     * @return void
+     * @return \Magento\Framework\Controller\Result\Redirect
      */
     public function execute()
     {
         $this->messageManager->addNotice(__('Your shopping cart has been updated with new prices.'));
-        $this->_redirect('checkout/cart');
+        $resultRedirect = $this->resultRedirectFactory->create();
+        $resultRedirect->setPath('checkout/cart');
+        return $resultRedirect;
     }
 }

app/code/Magento/Persistent/Controller/Index/SaveMethod.php

@@ -1,35 +1,31 @@
 <?php
 /**
- *
  * Copyright © 2015 Magento. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\Persistent\Controller\Index;
 
-class SaveMethod extends \Magento\Persistent\Controller\Index
-{
-    /**
-     * @var \Magento\Persistent\Model\QuoteManager
-     */
-    protected $quoteManager;
+use Magento\Persistent\Controller\Index;
 
+class SaveMethod extends Index
+{
     /**
      * Save onepage checkout method to be register
      *
-     * @return void
+     * @return \Magento\Framework\Controller\Result\Redirect
      */
     public function execute()
     {
-        if ($this->_getHelper()->isPersistent()) {
-            $this->_getHelper()->getSession()->removePersistentCookie();
-            if (!$this->_customerSession->isLoggedIn()) {
-                $this->_customerSession->setCustomerId(null)->setCustomerGroupId(null);
+        if ($this->sessionHelper->isPersistent()) {
+            $this->sessionHelper->getSession()->removePersistentCookie();
+            if (!$this->customerSession->isLoggedIn()) {
+                $this->customerSession->setCustomerId(null)->setCustomerGroupId(null);
             }
-
             $this->quoteManager->setGuest();
         }
-
         $checkoutUrl = $this->_redirect->getRefererUrl();
-        $this->getResponse()->setRedirect($checkoutUrl . (strpos($checkoutUrl, '?') ? '&' : '?') . 'register');
+        $resultRedirect = $this->resultRedirectFactory->create();
+        $resultRedirect->setPath($checkoutUrl . (strpos($checkoutUrl, '?') ? '&' : '?') . 'register');
+        return $resultRedirect;
     }
 }

app/code/Magento/Persistent/Controller/Index/UnsetCookie.php

@@ -1,40 +1,42 @@
 <?php
 /**
- *
  * Copyright © 2015 Magento. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\Persistent\Controller\Index;
 
-class UnsetCookie extends \Magento\Persistent\Controller\Index
+use Magento\Persistent\Controller\Index;
+
+class UnsetCookie extends Index
 {
     /**
      * Revert all persistent data
      *
      * @return $this
      */
-    protected function _cleanup()
+    protected function cleanup()
     {
         $this->_eventManager->dispatch('persistent_session_expired');
-        $this->_customerSession->setCustomerId(null)->setCustomerGroupId(null);
-        if ($this->_clearCheckoutSession) {
-            $this->_checkoutSession->clearStorage();
+        $this->customerSession->setCustomerId(null)->setCustomerGroupId(null);
+        if ($this->clearCheckoutSession) {
+            $this->checkoutSession->clearStorage();
         }
-        $this->_getHelper()->getSession()->removePersistentCookie();
+        $this->sessionHelper->getSession()->removePersistentCookie();
         return $this;
     }
 
     /**
      * Unset persistent cookie action
      *
-     * @return void
+     * @return \Magento\Framework\Controller\Result\Redirect
      */
     public function execute()
     {
-        if ($this->_getHelper()->isPersistent()) {
-            $this->_cleanup();
+        if ($this->sessionHelper->isPersistent()) {
+            $this->cleanup();
         }
-        $this->_redirect('customer/account/login');
-        return;
+        $resultRedirect = $this->resultRedirectFactory->create();
+        $resultRedirect->setPath('customer/account/login');
+        return $resultRedirect;
     }
 }