MAGETWO-36731: Refactor controller actions in the Search module

Author: Yuri Kovsher

app/code/Magento/Search/Controller/Ajax/Suggest.php

@@ -1,48 +1,54 @@
 <?php
 /**
- *
  * Copyright © 2015 Magento. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\Search\Controller\Ajax;
 
-use Magento\Search\Model\AutocompleteInterface;
+use Magento\Framework\App\Action\Action;
 use Magento\Framework\App\Action\Context;
+use Magento\Search\Model\AutocompleteInterface;
+use Magento\Framework\Controller\ResultFactory;
 
-class Suggest extends \Magento\Framework\App\Action\Action
+class Suggest extends Action
 {
     /**
-     * @var  AutocompleteInterface
+     * @var  \Magento\Search\Model\AutocompleteInterface
      */
     private $autocomplete;
 
     /**
-     * @param Context $context
-     * @param AutocompleteInterface $autocomplete
+     * @param \Magento\Framework\App\Action\Context $context
+     * @param \Magento\Search\Model\AutocompleteInterface $autocomplete
      */
     public function __construct(
         Context $context,
         AutocompleteInterface $autocomplete
     ) {
-        parent::__construct($context);
         $this->autocomplete = $autocomplete;
+        parent::__construct($context);
     }
 
     /**
-     * @return void
+     * @return \Magento\Framework\Controller\ResultInterface
      */
     public function execute()
     {
         if (!$this->getRequest()->getParam('q', false)) {
-            $this->getResponse()->setRedirect($this->_url->getBaseUrl());
-            return;
+            /** @var \Magento\Framework\Controller\Result\Redirect $resultRedirect */
+            $resultRedirect = $this->resultFactory->create(ResultFactory::TYPE_REDIRECT);
+            $resultRedirect->setUrl($this->_url->getBaseUrl());
+            return $resultRedirect;
         }
 
         $autocompleteData = $this->autocomplete->getItems();
         $responseData = [];
         foreach ($autocompleteData as $resultItem) {
             $responseData[] = $resultItem->toArray();
         }
-        $this->getResponse()->representJson(json_encode($responseData));
+        /** @var \Magento\Framework\Controller\Result\Json $resultJson */
+        $resultJson = $this->resultFactory->create(ResultFactory::TYPE_JSON);
+        $resultJson->setData($responseData);
+        return $resultJson;
     }
 }

app/code/Magento/Search/Controller/Term/Popular.php

@@ -5,22 +5,25 @@
  */
 namespace Magento\Search\Controller\Term;
 
+use Magento\Framework\App\Action\Action;
 use Magento\Framework\App\Action\Context;
+use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\RequestInterface;
-use Magento\Framework\App\ResponseInterface;
+use Magento\Store\Model\ScopeInterface;
+use Magento\Framework\Controller\ResultFactory;
 
-class Popular extends \Magento\Framework\App\Action\Action
+class Popular extends Action
 {
     /**
      * @var \Magento\Framework\App\Config\ScopeConfigInterface
      */
     protected $scopeConfig;
 
     /**
-     * @param Context $context
+     * @param \Magento\Framework\App\Action\Context $context
      * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
      */
-    public function __construct(Context $context, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig)
+    public function __construct(Context $context, ScopeConfigInterface $scopeConfig)
     {
         $this->scopeConfig = $scopeConfig;
         parent::__construct($context);
@@ -29,14 +32,14 @@ public function __construct(Context $context, \Magento\Framework\App\Config\Scop
     /**
      * Dispatch request
      *
-     * @param RequestInterface $request
-     * @return ResponseInterface
+     * @param \Magento\Framework\App\RequestInterface $request
+     * @return \Magento\Framework\App\ResponseInterface
      */
     public function dispatch(RequestInterface $request)
     {
         $searchTerms = $this->scopeConfig->getValue(
             'catalog/seo/search_terms',
-            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
+            ScopeInterface::SCOPE_STORE
         );
         if (!$searchTerms) {
             $this->_redirect('noroute');
@@ -46,11 +49,12 @@ public function dispatch(RequestInterface $request)
     }
 
     /**
-     * @return void
+     * @return \Magento\Framework\View\Result\Page
      */
     public function execute()
     {
-        $this->_view->loadLayout();
-        $this->_view->renderLayout();
+        /** @var \Magento\Framework\View\Result\Page $resultPage */
+        $resultPage = $this->resultFactory->create(ResultFactory::TYPE_PAGE);
+        return $resultPage;
     }
 }