MAGETWO-34989: Implement getDefaultRedirect() method

Author: Dmytro Poperechnyy

app/code/Magento/Backend/App/Action/Context.php

@@ -68,6 +68,7 @@ class Context extends \Magento\Framework\App\Action\Context
      * @param \Magento\Backend\Model\UrlInterface $backendUrl
      * @param \Magento\Framework\Data\Form\FormKey\Validator $formKeyValidator
      * @param \Magento\Framework\Locale\ResolverInterface $localeResolver
+     * @param \Magento\Backend\Model\View\Result\RedirectFactory $resultRedirectFactory
      * @param bool $canUseBaseUrl
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
@@ -88,6 +89,7 @@ public function __construct(
         \Magento\Backend\Model\UrlInterface $backendUrl,
         \Magento\Framework\Data\Form\FormKey\Validator $formKeyValidator,
         \Magento\Framework\Locale\ResolverInterface $localeResolver,
+        \Magento\Backend\Model\View\Result\RedirectFactory $resultRedirectFactory,
         $canUseBaseUrl = false
     ) {
         parent::__construct(
@@ -99,7 +101,8 @@ public function __construct(
             $redirect,
             $actionFlag,
             $view,
-            $messageManager
+            $messageManager,
+            $resultRedirectFactory
         );
 
         $this->_session = $session;

app/code/Magento/Backend/Model/View/Result/Redirect.php

@@ -42,6 +42,17 @@ public function __construct(
         parent::__construct($redirect, $urlBuilder);
     }
 
+    /**
+     * Set referer url or dashboard if referer does not exist
+     *
+     * @return $this
+     */
+    public function setRefererOrBaseUrl()
+    {
+        $this->url = $this->redirect->getRedirectUrl($this->urlBuilder->getUrl('adminhtml/index'));
+        return $this;
+    }
+
     /**
      * {@inheritdoc}
      */

app/code/Magento/Backend/Model/View/Result/RedirectFactory.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Backend\Model\View\Result;
+
+use Magento\Framework\ObjectManagerInterface;
+
+class RedirectFactory extends \Magento\Framework\Controller\Result\RedirectFactory
+{
+    /**
+     * Object Manager instance
+     *
+     * @var ObjectManagerInterface
+     */
+    protected $objectManager;
+
+    /**
+     * Instance name to create
+     *
+     * @var string
+     */
+    protected $instanceName;
+
+    /**
+     * @param ObjectManagerInterface $objectManager
+     * @param string $instanceName
+     */
+    public function __construct(
+        ObjectManagerInterface $objectManager,
+        $instanceName = 'Magento\Backend\Model\View\Result\Redirect'
+    ) {
+        $this->objectManager = $objectManager;
+        $this->instanceName = $instanceName;
+    }
+
+    /**
+     * Create class instance with specified parameters
+     *
+     * @param array $data
+     * @return \Magento\Backend\Model\View\Result\Redirect
+     */
+    public function create(array $data = [])
+    {
+        return $this->objectManager->create($this->instanceName, $data);
+    }
+}

lib/internal/Magento/Framework/App/Action/AbstractAction.php

@@ -19,16 +19,30 @@ abstract class AbstractAction implements \Magento\Framework\App\ActionInterface
      */
     protected $_response;
 
+    /**
+     * @var \Magento\Framework\App\Action\Context $context
+     */
+    protected $context;
+
+    /**
+     * @var \Magento\Framework\Controller\Result\RedirectFactory
+     */
+    protected $resultRedirectFactory;
+
     /**
      * @param \Magento\Framework\App\RequestInterface $request
      * @param \Magento\Framework\App\ResponseInterface $response
+     * @param \Magento\Framework\App\Action\Context $context
      */
     public function __construct(
         \Magento\Framework\App\RequestInterface $request,
-        \Magento\Framework\App\ResponseInterface $response
+        \Magento\Framework\App\ResponseInterface $response,
+        \Magento\Framework\App\Action\Context $context
     ) {
         $this->_request = $request;
         $this->_response = $response;
+        $this->context = $context;
+        $this->resultRedirectFactory = $context->getResultRedirectFactory();
     }
 
     /**
@@ -50,4 +64,15 @@ public function getResponse()
     {
         return $this->_response;
     }
+
+    /**
+     * Redirect user to the previous or main page
+     *
+     * @return \Magento\Framework\Controller\Result\Redirect|\Magento\Backend\Model\View\Result\Redirect
+     */
+    public function getDefaultRedirect()
+    {
+        $resultRedirect = $this->resultRedirectFactory->create();
+        return $resultRedirect->setRefererOrBaseUrl();
+    }
 }

lib/internal/Magento/Framework/App/Action/Action.php

@@ -65,7 +65,7 @@ class Action extends AbstractAction
      */
     public function __construct(Context $context)
     {
-        parent::__construct($context->getRequest(), $context->getResponse());
+        parent::__construct($context->getRequest(), $context->getResponse(), $context);
         $this->_objectManager = $context->getObjectManager();
         $this->_eventManager = $context->getEventManager();
         $this->_url = $context->getUrl();

lib/internal/Magento/Framework/App/Action/Context.php

@@ -52,6 +52,11 @@ class Context implements \Magento\Framework\ObjectManager\ContextInterface
      */
     protected $messageManager;
 
+    /**
+     * @var \Magento\Framework\Controller\Result\RedirectFactory
+     */
+    protected $resultRedirectFactory;
+
     /**
      * @param \Magento\Framework\App\RequestInterface $request
      * @param \Magento\Framework\App\ResponseInterface $response
@@ -62,6 +67,7 @@ class Context implements \Magento\Framework\ObjectManager\ContextInterface
      * @param \Magento\Framework\App\ActionFlag $actionFlag
      * @param \Magento\Framework\App\ViewInterface $view
      * @param \Magento\Framework\Message\ManagerInterface $messageManager
+     * @param \Magento\Framework\Controller\Result\RedirectFactory $resultRedirectFactory
      *
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
@@ -74,7 +80,8 @@ public function __construct(
         \Magento\Framework\App\Response\RedirectInterface $redirect,
         \Magento\Framework\App\ActionFlag $actionFlag,
         \Magento\Framework\App\ViewInterface $view,
-        \Magento\Framework\Message\ManagerInterface $messageManager
+        \Magento\Framework\Message\ManagerInterface $messageManager,
+        \Magento\Framework\Controller\Result\RedirectFactory $resultRedirectFactory
     ) {
         $this->_request = $request;
         $this->_response = $response;
@@ -85,6 +92,7 @@ public function __construct(
         $this->_actionFlag = $actionFlag;
         $this->_view = $view;
         $this->messageManager = $messageManager;
+        $this->resultRedirectFactory = $resultRedirectFactory;
     }
 
     /**
@@ -158,4 +166,12 @@ public function getMessageManager()
     {
         return $this->messageManager;
     }
+
+    /**
+     * @return \Magento\Framework\Controller\Result\RedirectFactory
+     */
+    public function getResultRedirectFactory()
+    {
+        return $this->resultRedirectFactory;
+    }
 }

lib/internal/Magento/Framework/App/ActionInterface.php

@@ -34,4 +34,11 @@ public function dispatch(RequestInterface $request);
      * @return ResponseInterface
      */
     public function getResponse();
+
+    /**
+     * Redirect to custom, previous or main page
+     *
+     * @return \Magento\Framework\Controller\ResultInterface
+     */
+    public function getDefaultRedirect();
 }