ENGCOM-6325: add the possibility to add display mode dependant layout handles #25718

 - Merge Pull Request #25718 from brosenberger/magento2:add-displaymode-pagelayouthandles
 - Merged commits:
   1. 88da782
   2. ae0ab69
   3. 65f7610
   4. 890206a
   5. 4cd5cd2
   6. f37eb05

Author: magento-engcom-team

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

@@ -9,6 +9,7 @@
 use Magento\Catalog\Api\CategoryRepositoryInterface;
 use Magento\Catalog\Helper\Category as CategoryHelper;
 use Magento\Catalog\Model\Category;
+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;
@@ -30,7 +31,6 @@
 use Magento\Framework\View\Result\PageFactory;
 use Magento\Store\Model\StoreManagerInterface;
 use Psr\Log\LoggerInterface;
-use Magento\Catalog\Model\Category\Attribute\LayoutUpdateManager;
 
 /**
  * View a category on storefront. Needs to be accessible by POST because of the store switching.
@@ -208,8 +208,10 @@ protected function _initCategory()
      * @return ResultInterface
      * @throws NoSuchEntityException
      */
-    public function execute()
+    public function execute(): ?ResultInterface
     {
+        $result = null;
+
         if ($this->_request->getParam(ActionInterface::PARAM_NAME_URL_ENCODED)) {
             return $this->resultRedirectFactory->create()->setUrl($this->_redirect->getRedirectUrl());
         }
@@ -239,6 +241,7 @@ public function execute()
                 $page->addPageLayoutHandles(['type' => $parentPageType], null, false);
             }
             $page->addPageLayoutHandles(['type' => $pageType], null, false);
+            $page->addPageLayoutHandles(['displaymode' => strtolower($category->getDisplayMode())], null, false);
             $page->addPageLayoutHandles(['id' => $category->getId()]);
 
             // apply custom layout update once layout is loaded
@@ -250,8 +253,9 @@ public function execute()
 
             return $page;
         } elseif (!$this->getResponse()->isRedirect()) {
-            return $this->resultForwardFactory->create()->forward('noroute');
+            $result = $this->resultForwardFactory->create()->forward('noroute');
         }
+        return $result;
     }
 
     /**

app/code/Magento/Catalog/Test/Unit/Controller/Category/ViewTest.php

@@ -178,7 +178,13 @@ protected function setUp()
         );
     }
 
-    public function testApplyCustomLayoutUpdate()
+    /**
+     * Apply custom layout update is correct
+     *
+     * @dataProvider getInvocationData
+     * @return void
+     */
+    public function testApplyCustomLayoutUpdate(array $expectedData): void
     {
         $categoryId = 123;
         $pageLayout = 'page_layout';
@@ -199,11 +205,70 @@ public function testApplyCustomLayoutUpdate()
             \Magento\Framework\DataObject::class,
             ['getPageLayout', 'getLayoutUpdates']
         );
+        $this->category->expects($this->at(1))
+            ->method('hasChildren')
+            ->willReturn(true);
+        $this->category->expects($this->at(2))
+            ->method('hasChildren')
+            ->willReturn($expectedData[1][0]['type'] === 'default' ? true : false);
+        $this->category->expects($this->once())
+            ->method('getDisplayMode')
+            ->willReturn($expectedData[2][0]['displaymode']);
+        $this->expectationForPageLayoutHandles($expectedData);
         $settings->expects($this->atLeastOnce())->method('getPageLayout')->will($this->returnValue($pageLayout));
         $settings->expects($this->once())->method('getLayoutUpdates')->willReturn(['update1', 'update2']);
-
         $this->catalogDesign->expects($this->any())->method('getDesignSettings')->will($this->returnValue($settings));
 
         $this->action->execute();
     }
+
+    /**
+     * Expected invocation for Layout Handles
+     *
+     * @param array $data
+     * @return void
+     */
+    private function expectationForPageLayoutHandles($data): void
+    {
+        $index = 1;
+
+        foreach ($data as $expectedData) {
+            $this->page->expects($this->at($index))
+            ->method('addPageLayoutHandles')
+            ->with($expectedData[0], $expectedData[1], $expectedData[2]);
+            $index++;
+        }
+    }
+
+    /**
+     * Data provider for execute method.
+     *
+     * @return array
+     */
+    public function getInvocationData(): array
+    {
+        return [
+            [
+                'layoutHandles' => [
+                    [['type' => 'default'], null, false],
+                    [['type' => 'default_without_children'], null, false],
+                    [['displaymode' => 'products'], null, false]
+                ]
+            ],
+            [
+                'layoutHandles' => [
+                    [['type' => 'default'], null, false],
+                    [['type' => 'default_without_children'], null, false],
+                    [['displaymode' => 'page'], null, false]
+                ]
+            ],
+            [
+                'layoutHandles' => [
+                    [['type' => 'default'], null, false],
+                    [['type' => 'default'], null, false],
+                    [['displaymode' => 'poducts_and_page'], null, false]
+                ]
+            ]
+        ];
+    }
 }