SwiftOtter-SOP-348 Reduce cyclomatic complexity (<10) + fix Static checks

Author: lbajsarowicz

app/code/Magento/Catalog/Controller/Category/View.php

@@ -3,6 +3,9 @@
  * Copyright 2014 Adobe
  * All Rights Reserved.
  */
+
+declare(strict_types=1);
+
 namespace Magento\Catalog\Controller\Category;
 
 use Magento\Catalog\Api\CategoryRepositoryInterface;
@@ -11,8 +14,8 @@
 use Magento\Catalog\Model\Category\Attribute\LayoutUpdateManager;
 use Magento\Catalog\Model\Design;
 use Magento\Catalog\Model\Layer\Resolver;
-use Magento\Catalog\Model\Product\ProductList\ToolbarMemorizer;
 use Magento\Catalog\Model\Product\ProductList\Toolbar;
+use Magento\Catalog\Model\Product\ProductList\ToolbarMemorizer;
 use Magento\Catalog\Model\Session;
 use Magento\CatalogUrlRewrite\Model\CategoryUrlPathGenerator;
 use Magento\Framework\App\Action\Action;
@@ -21,8 +24,10 @@
 use Magento\Framework\App\Action\HttpPostActionInterface;
 use Magento\Framework\App\ActionInterface;
 use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Controller\Result\Forward;
 use Magento\Framework\Controller\Result\ForwardFactory;
-use Magento\Framework\Controller\ResultFactory;
+use Magento\Framework\Controller\Result\Redirect;
+use Magento\Framework\Controller\ResultInterface;
 use Magento\Framework\DataObject;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Exception\NoSuchEntityException;
@@ -107,8 +112,6 @@ class View extends Action implements HttpGetActionInterface, HttpPostActionInter
     private $logger;
 
     /**
-     * Constructor
-     *
      * @param Context $context
      * @param Design $catalogDesign
      * @param Session $catalogSession
@@ -121,8 +124,8 @@ class View extends Action implements HttpGetActionInterface, HttpPostActionInter
      * @param CategoryRepositoryInterface $categoryRepository
      * @param ToolbarMemorizer|null $toolbarMemorizer
      * @param LayoutUpdateManager|null $layoutUpdateManager
-     * @param CategoryHelper $categoryHelper
-     * @param LoggerInterface $logger
+     * @param CategoryHelper|null $categoryHelper
+     * @param LoggerInterface|null $logger
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -161,9 +164,7 @@ public function __construct(
     }
 
     /**
-     * Initialize requested category object
-     *
-     * @return Category|bool
+     * @return Category|false
      */
     protected function _initCategory()
     {
@@ -189,109 +190,132 @@ protected function _initCategory()
                 ['category' => $category, 'controller_action' => $this]
             );
         } catch (LocalizedException $e) {
-            $this->logger->critical($e);
+            $this->logger->critical((string)$e);
             return false;
         }
 
         return $category;
     }
 
     /**
-     * Category view action
-     *
+     * @return ResultInterface
      * @throws NoSuchEntityException
      */
     public function execute()
     {
-        $result = null;
-
         if ($this->_request->getParam(ActionInterface::PARAM_NAME_URL_ENCODED)) {
             //phpcs:ignore Magento2.Legacy.ObsoleteResponse
             return $this->resultRedirectFactory->create()->setUrl($this->_redirect->getRedirectUrl());
         }
 
         $category = $this->_initCategory();
-        if ($category) {
-            // Negative ?p= value is not supported, redirect to a base version of category page.
-            if ($this->_request->getParam(Toolbar::PAGE_PARM_NAME) < 0) {
-                return $this->resultRedirectFactory->create()
-                    ->setHttpResponseCode(301)
-                    ->setUrl($category->getUrl());
-            }
+        if (!$category) {
+            return $this->resultForwardFactory->create()->forward('noroute');
+        }
 
-            $this->layerResolver->create(Resolver::CATALOG_LAYER_CATEGORY);
-            $settings = $this->_catalogDesign->getDesignSettings($category);
+        $pageRedirect = $this->handlePageRedirect($category);
+        if ($pageRedirect) {
+            return $pageRedirect;
+        }
 
-            // apply custom design
-            if ($settings->getCustomDesign()) {
-                $this->_catalogDesign->applyCustomDesign($settings->getCustomDesign());
-            }
+        $page = $this->preparePage($category);
 
-            $this->_catalogSession->setLastViewedCategoryId($category->getId());
+        if ($this->shouldRedirectOnToolbarAction()) {
+            $this->getResponse()->setRedirect($this->_redirect->getRedirectUrl());
+        }
 
-            $page = $this->resultPageFactory->create();
-            // apply custom layout (page) template once the blocks are generated
-            if ($settings->getPageLayout()) {
-                $page->getConfig()->setPageLayout($settings->getPageLayout());
-            }
+        return $page;
+    }
 
-            $pageType = $this->getPageType($category);
+    /**
+     * @param Category $category
+     * @return Redirect|null
+     */
+    private function handlePageRedirect(Category $category): ?Redirect
+    {
+        if ($this->_request->getParam(Toolbar::PAGE_PARM_NAME) < 0) {
+            return $this->resultRedirectFactory->create()
+                ->setHttpResponseCode(301)
+                ->setUrl($category->getUrl());
+        }
 
-            if (!$category->hasChildren()) {
-                // Two levels removed from parent.  Need to add default page type.
-                $parentPageType = strtok($pageType, '_');
-                $page->addPageLayoutHandles(['type' => $parentPageType], null, false);
-            }
-            $page->addPageLayoutHandles(['type' => $pageType], null, false);
-            $categoryDisplayMode = is_string($category->getDisplayMode()) ?
-                strtolower($category->getDisplayMode()) : '';
-            $page->addPageLayoutHandles(['displaymode' => $categoryDisplayMode], null, false);
-            $page->addPageLayoutHandles(['id' => $category->getId()]);
+        return null;
+    }
 
-            // apply custom layout update once layout is loaded
-            $this->applyLayoutUpdates($page, $settings);
+    /**
+     * @param Category $category
+     * @return Page
+     */
+    private function preparePage(Category $category): Page
+    {
+        $this->layerResolver->create(Resolver::CATALOG_LAYER_CATEGORY);
+        $settings = $this->_catalogDesign->getDesignSettings($category);
+
+        if ($settings->getCustomDesign()) {
+            $this->_catalogDesign->applyCustomDesign($settings->getCustomDesign());
+        }
 
-            $page->getConfig()->addBodyClass('page-products')
-                ->addBodyClass('categorypath-' . $this->categoryUrlPathGenerator->getUrlPath($category))
-                ->addBodyClass('category-' . $category->getUrlKey());
+        $this->_catalogSession->setLastViewedCategoryId($category->getId());
 
-            if ($this->shouldRedirectOnToolbarAction()) {
-                $this->getResponse()->setRedirect($this->_redirect->getRedirectUrl());
-            }
-            return $page;
-        } elseif (!$this->getResponse()->isRedirect()) {
-            $result = $this->resultForwardFactory->create()->forward('noroute');
+        $page = $this->resultPageFactory->create();
+        if ($settings->getPageLayout()) {
+            $page->getConfig()->setPageLayout($settings->getPageLayout());
         }
-        return $result;
+
+        $this->addPageLayoutHandles($page, $category);
+        $this->applyLayoutUpdates($page, $settings);
+
+        $page->getConfig()->addBodyClass('page-products')
+            ->addBodyClass('categorypath-' . $this->categoryUrlPathGenerator->getUrlPath($category))
+            ->addBodyClass('category-' . $category->getUrlKey());
+
+        return $page;
+    }
+
+    /**
+     * @param Page $page
+     * @param Category $category
+     * @return void
+     */
+    private function addPageLayoutHandles(Page $page, Category $category): void
+    {
+        $pageType = $this->getPageType($category);
+
+        if (!$category->hasChildren()) {
+            $parentPageType = strtok($pageType, '_');
+            $page->addPageLayoutHandles(['type' => $parentPageType], null, false);
+        }
+        $page->addPageLayoutHandles(['type' => $pageType], null, false);
+
+        $categoryDisplayMode = is_string($category->getDisplayMode()) ?
+            strtolower($category->getDisplayMode()) : '';
+        $page->addPageLayoutHandles(['displaymode' => $categoryDisplayMode], null, false);
+        $page->addPageLayoutHandles(['id' => $category->getId()]);
     }
 
     /**
-     * Get page type based on category
-     *
      * @param Category $category
      * @return string
      */
-    private function getPageType(Category $category) : string
+    private function getPageType(Category $category): string
     {
         $hasChildren = $category->hasChildren();
         if ($category->getIsAnchor()) {
-            return  $hasChildren ? 'layered' : 'layered_without_children';
+            return $hasChildren ? 'layered' : 'layered_without_children';
         }
 
         return $hasChildren ? 'default' : 'default_without_children';
     }
 
     /**
-     * Apply custom layout updates
-     *
      * @param Page $page
      * @param DataObject $settings
      * @return void
      */
     private function applyLayoutUpdates(
         Page $page,
         DataObject $settings
-    ) {
+    ): void {
         $layoutUpdates = $settings->getLayoutUpdates();
         if ($layoutUpdates && is_array($layoutUpdates)) {
             foreach ($layoutUpdates as $layoutUpdate) {
@@ -300,26 +324,23 @@ private function applyLayoutUpdates(
             }
         }
 
-        //Selected files
         if ($settings->getPageLayoutHandles()) {
             $page->addPageLayoutHandles($settings->getPageLayoutHandles());
         }
     }
 
     /**
-     * Checks for toolbar actions
-     *
      * @return bool
      */
     private function shouldRedirectOnToolbarAction(): bool
     {
         $params = $this->getRequest()->getParams();
 
-        return $this->toolbarMemorizer->isMemorizingAllowed() && empty(array_intersect([
+        return $this->toolbarMemorizer->isMemorizingAllowed() && !empty(array_intersect([
                 Toolbar::ORDER_PARAM_NAME,
                 Toolbar::DIRECTION_PARAM_NAME,
                 Toolbar::MODE_PARAM_NAME,
                 Toolbar::LIMIT_PARAM_NAME
-            ], array_keys($params))) === false;
+            ], array_keys($params)));
     }
 }