Merge remote-tracking branch 'origin/MC-38625' into 2.4-develop-pr51

Author: Serhii Balko

app/code/Magento/Sales/Block/Order/Items.php

@@ -9,18 +9,28 @@
  */
 namespace Magento\Sales\Block\Order;
 
+use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Registry;
+use Magento\Framework\View\Element\AbstractBlock;
+use Magento\Framework\View\Element\Template\Context;
+use Magento\Sales\Block\Items\AbstractItems;
+use Magento\Sales\Model\Order;
+use Magento\Sales\Model\ResourceModel\Order\Item\Collection;
+use Magento\Sales\Model\ResourceModel\Order\Item\CollectionFactory;
+use Magento\Theme\Block\Html\Pager;
+
 /**
  * Sales order view items block.
  *
  * @api
  * @since 100.0.2
  */
-class Items extends \Magento\Sales\Block\Items\AbstractItems
+class Items extends AbstractItems
 {
     /**
      * Core registry
      *
-     * @var \Magento\Framework\Registry
+     * @var Registry
      */
     protected $_coreRegistry = null;
 
@@ -32,30 +42,30 @@ class Items extends \Magento\Sales\Block\Items\AbstractItems
     private $itemsPerPage;
 
     /**
-     * @var \Magento\Sales\Model\ResourceModel\Order\Item\CollectionFactory
+     * @var CollectionFactory
      */
     private $itemCollectionFactory;
 
     /**
-     * @var \Magento\Sales\Model\ResourceModel\Order\Item\Collection|null
+     * @var Collection|null
      */
     private $itemCollection;
 
     /**
-     * @param \Magento\Framework\View\Element\Template\Context $context
-     * @param \Magento\Framework\Registry $registry
+     * @param Context $context
+     * @param Registry $registry
      * @param array $data
-     * @param \Magento\Sales\Model\ResourceModel\Order\Item\CollectionFactory|null $itemCollectionFactory
+     * @param CollectionFactory|null $itemCollectionFactory
      */
     public function __construct(
-        \Magento\Framework\View\Element\Template\Context $context,
-        \Magento\Framework\Registry $registry,
+        Context $context,
+        Registry $registry,
         array $data = [],
-        \Magento\Sales\Model\ResourceModel\Order\Item\CollectionFactory $itemCollectionFactory = null
+        CollectionFactory $itemCollectionFactory = null
     ) {
         $this->_coreRegistry = $registry;
-        $this->itemCollectionFactory = $itemCollectionFactory ?: \Magento\Framework\App\ObjectManager::getInstance()
-            ->get(\Magento\Sales\Model\ResourceModel\Order\Item\CollectionFactory::class);
+        $this->itemCollectionFactory = $itemCollectionFactory ?: ObjectManager::getInstance()
+            ->get(CollectionFactory::class);
         parent::__construct($context, $data);
     }
 
@@ -68,18 +78,12 @@ public function __construct(
     protected function _prepareLayout()
     {
         $this->itemsPerPage = $this->_scopeConfig->getValue('sales/orders/items_per_page');
+        $this->itemCollection = $this->createItemsCollection();
 
-        $this->itemCollection = $this->itemCollectionFactory->create();
-        $this->itemCollection->setOrderFilter($this->getOrder());
-
-        /** @var \Magento\Theme\Block\Html\Pager $pagerBlock */
+        /** @var Pager $pagerBlock */
         $pagerBlock = $this->getChildBlock('sales_order_item_pager');
         if ($pagerBlock) {
-            $pagerBlock->setLimit($this->itemsPerPage);
-            //here pager updates collection parameters
-            $pagerBlock->setCollection($this->itemCollection);
-            $pagerBlock->setAvailableLimit([$this->itemsPerPage]);
-            $pagerBlock->setShowAmounts($this->isPagerDisplayed());
+            $this->preparePager($pagerBlock);
         }
 
         return parent::_prepareLayout();
@@ -122,18 +126,47 @@ public function getItems()
      */
     public function getPagerHtml()
     {
-        /** @var \Magento\Theme\Block\Html\Pager $pagerBlock */
+        /** @var Pager $pagerBlock */
         $pagerBlock = $this->getChildBlock('sales_order_item_pager');
         return $pagerBlock ? $pagerBlock->toHtml() : '';
     }
 
     /**
      * Retrieve current order model instance
      *
-     * @return \Magento\Sales\Model\Order
+     * @return Order
      */
     public function getOrder()
     {
         return $this->_coreRegistry->registry('current_order');
     }
+
+    /**
+     * Prepare pager block
+     *
+     * @param AbstractBlock $pagerBlock
+     */
+    private function preparePager(AbstractBlock $pagerBlock): void
+    {
+        $collectionToPager = $this->createItemsCollection();
+        $collectionToPager->addFieldToFilter('parent_item_id', ['null' => true]);
+        $pagerBlock->setCollection($collectionToPager);
+
+        $pagerBlock->setLimit($this->itemsPerPage);
+        $pagerBlock->setAvailableLimit([$this->itemsPerPage]);
+        $pagerBlock->setShowAmounts($this->isPagerDisplayed());
+    }
+
+    /**
+     * Create items collection
+     *
+     * @return Collection
+     */
+    private function createItemsCollection(): Collection
+    {
+        $collection = $this->itemCollectionFactory->create();
+        $collection->setOrderFilter($this->getOrder());
+
+        return $collection;
+    }
 }

dev/tests/integration/testsuite/Magento/Sales/Block/Order/ItemsTest.php

@@ -81,6 +81,22 @@ public function testGetOrderItems(): void
         $this->assertCount(1, $this->block->getItems());
     }
 
+    /**
+     * @magentoDataFixture Magento/Sales/_files/order_configurable_product.php
+     *
+     * @return void
+     */
+    public function testGetPagerCountConfigurable(): void
+    {
+        $order = $this->orderFactory->create()->loadByIncrementId('100000001');
+        $this->registerOrder($order);
+        $this->prepareBlockWithPager();
+
+        /** @var Pager $pagerBlock */
+        $pagerBlock = $this->block->getChildBlock('sales_order_item_pager');
+        $this->assertCount(1, $pagerBlock->getCollection()->getItems());
+    }
+
     /**
      * @magentoConfigFixture default/sales/orders/items_per_page 3
      * @magentoDataFixture Magento/Sales/_files/order_item_list.php
@@ -91,13 +107,7 @@ public function testPagerIsDisplayed(): void
     {
         $order = $this->orderFactory->create()->loadByIncrementId('100000001');
         $this->registerOrder($order);
-        $this->block = $this->layout->createBlock(Items::class, 'items_block');
-        $this->layout->addBlock(
-            $this->objectManager->get(Pager::class),
-            'sales_order_item_pager',
-            'items_block'
-        );
-        $this->block->setLayout($this->layout);
+        $this->prepareBlockWithPager();
         $this->assertTrue($this->block->isPagerDisplayed());
     }
 
@@ -110,13 +120,7 @@ public function testPagerIsNotDisplayed(): void
     {
         $order = $this->orderFactory->create()->loadByIncrementId('100000001');
         $this->registerOrder($order);
-        $this->block = $this->layout->createBlock(Items::class, 'items_block');
-        $this->layout->addBlock(
-            $this->objectManager->get(Pager::class),
-            'sales_order_item_pager',
-            'items_block'
-        );
-        $this->block->setLayout($this->layout);
+        $this->prepareBlockWithPager();
         $this->assertFalse($this->block->isPagerDisplayed());
         $this->assertEmpty(preg_replace('/\s+/', '', strip_tags($this->block->getPagerHtml())));
     }
@@ -131,13 +135,7 @@ public function testGetPagerHtml(): void
     {
         $order = $this->orderFactory->create()->loadByIncrementId('100000001');
         $this->registerOrder($order);
-        $this->block = $this->layout->createBlock(Items::class, 'items_block');
-        $this->layout->addBlock(
-            $this->objectManager->get(Pager::class),
-            'sales_order_item_pager',
-            'items_block'
-        );
-        $this->block->setLayout($this->layout);
+        $this->prepareBlockWithPager();
         $this->assertNotEmpty(preg_replace('/\s+/', '', strip_tags($this->block->getPagerHtml())));
         $this->assertTrue($this->block->isPagerDisplayed());
     }
@@ -227,4 +225,18 @@ private function registerOrder(OrderInterface $order): void
         $this->registry->unregister('current_order');
         $this->registry->register('current_order', $order);
     }
+
+    /**
+     * Create items block with pager
+     */
+    private function prepareBlockWithPager(): void
+    {
+        $this->block = $this->layout->createBlock(Items::class, 'items_block');
+        $this->layout->addBlock(
+            $this->objectManager->get(Pager::class),
+            'sales_order_item_pager',
+            'items_block'
+        );
+        $this->block->setLayout($this->layout);
+    }
 }