Skip to content

Add visibility and status filter to category product grid #12564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@
use Magento\Backend\Block\Widget\Grid;
use Magento\Backend\Block\Widget\Grid\Column;
use Magento\Backend\Block\Widget\Grid\Extended;
use Magento\Catalog\Model\Product\Attribute\Source\Status;
use Magento\Catalog\Model\Product\Visibility;
use Magento\Framework\App\ObjectManager;

class Product extends \Magento\Backend\Block\Widget\Grid\Extended
{
Expand All @@ -29,22 +32,38 @@ class Product extends \Magento\Backend\Block\Widget\Grid\Extended
*/
protected $_productFactory;

/**
* @var Status
*/
private $status;

/**
* @var Visibility
*/
private $visibility;

/**
* @param \Magento\Backend\Block\Template\Context $context
* @param \Magento\Backend\Helper\Data $backendHelper
* @param \Magento\Catalog\Model\ProductFactory $productFactory
* @param \Magento\Framework\Registry $coreRegistry
* @param array $data
* @param Visibility|null $visibility
* @param Status|null $status
*/
public function __construct(
\Magento\Backend\Block\Template\Context $context,
\Magento\Backend\Helper\Data $backendHelper,
\Magento\Catalog\Model\ProductFactory $productFactory,
\Magento\Framework\Registry $coreRegistry,
array $data = []
array $data = [],
Visibility $visibility = null,
Status $status = null
) {
$this->_productFactory = $productFactory;
$this->_coreRegistry = $coreRegistry;
$this->visibility = $visibility ?: ObjectManager::getInstance()->get(Visibility::class);
$this->status = $status ?: ObjectManager::getInstance()->get(Status::class);
parent::__construct($context, $backendHelper, $data);
}

Expand Down Expand Up @@ -102,6 +121,10 @@ protected function _prepareCollection()
'name'
)->addAttributeToSelect(
'sku'
)->addAttributeToSelect(
'visibility'
)->addAttributeToSelect(
'status'
)->addAttributeToSelect(
'price'
)->joinField(
Expand Down Expand Up @@ -159,6 +182,28 @@ protected function _prepareColumns()
);
$this->addColumn('name', ['header' => __('Name'), 'index' => 'name']);
$this->addColumn('sku', ['header' => __('SKU'), 'index' => 'sku']);
$this->addColumn(
'visibility',
[
'header' => __('Visibility'),
'index' => 'visibility',
'type' => 'options',
'options' => $this->visibility->getOptionArray(),
'header_css_class' => 'col-visibility',
'column_css_class' => 'col-visibility'
]
);

$this->addColumn(
'status',
[
'header' => __('Status'),
'index' => 'status',
'type' => 'options',
'options' => $this->status->getOptionArray()
]
);

$this->addColumn(
'price',
[
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ class ProductGrid extends Grid
'name' => [
'selector' => '#catalog_category_products_filter_name',
],
'visibility' => [
'selector' => '#catalog_category_products_filter_visibility',
'input' => 'select',
],
'status' => [
'selector' => '#catalog_category_products_filter_status',
'input' => 'select',
],
];

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

namespace Magento\Catalog\Test\Constraint;

use Magento\Catalog\Test\Fixture\Category;
use Magento\Catalog\Test\Page\Adminhtml\CatalogCategoryEdit;
use Magento\Catalog\Test\Page\Adminhtml\CatalogCategoryIndex;
use Magento\Mtf\Constraint\AbstractConstraint;

/**
* Assert that category products grid filter works correctly.
*/
class AssertCategoryProductsGridFilter extends AbstractConstraint
{
/**
* Grid columns for tests
*
* @var array
*/
private $testFilterColumns = [
'visibility',
];

/**
* Assert that category products grid filter works correctly.
*
* @param CatalogCategoryIndex $catalogCategoryIndex
* @param CatalogCategoryEdit $catalogCategoryEdit
* @param Category $category
* @return void
*/
public function processAssert(
CatalogCategoryIndex $catalogCategoryIndex,
CatalogCategoryEdit $catalogCategoryEdit,
Category $category
) {
$catalogCategoryIndex->getTreeCategories()->selectCategory($category, true);
$categoryProducts = $category->getDataFieldConfig('category_products')['source']->getProducts();
$catalogCategoryEdit->getEditForm()->openSection('category_products');

foreach ($this->testFilterColumns as $field) {
$this->testGridFilter($categoryProducts, $catalogCategoryEdit, $field);
}
}

/**
* @param array $categoryProducts
* @param CatalogCategoryEdit $catalogCategoryEdit
* @param string $filterField
*/
private function testGridFilter(array $categoryProducts, CatalogCategoryEdit $catalogCategoryEdit, $filterField)
{
$productsByFilter = [];
foreach ($categoryProducts as $product) {
$filterValue = $product->getData($filterField);
if (!isset($productsByFilter[$filterValue])) {
$productsByFilter[$filterValue] = [];
}
$productsByFilter[$filterValue][] = $product;
}

$productsFieldset = $catalogCategoryEdit->getEditForm()->getSection('category_products');
foreach ($productsByFilter as $filterValue => $products) {
$productsFieldset->getProductGrid()->search([
'in_category' => 'Yes',
$filterField => $filterValue,
]);

$expectedRows = [];
foreach ($products as $product) {
$expectedRows[] = $product->getName();
}
$gridRows = $productsFieldset->getProductGrid()->getRowsData(['name']);
$actualRows = array_column($gridRows, 'name');
sort($expectedRows);
sort($actualRows);

\PHPUnit_Framework_Assert::assertEquals(
$expectedRows,
$actualRows,
"Category products grid filter '$filterField' does not work correctly"
);
}
}

/**
* Returns a string representation of the object.
*
* @return string
*/
public function toString()
{
return 'Category products grid filter works correctly';
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -175,5 +175,15 @@
<constraint name="Magento\Catalog\Test\Constraint\AssertCategorySaveMessage" />
<constraint name="Magento\Catalog\Test\Constraint\AssertCategoryOnCustomWebsite" />
</variation>
<variation name="CreateCategoryEntityTestVariation11_ProductsGridFilter" summary="Apply category products grid filter">
<data name="addCategory" xsi:type="string">addSubcategory</data>
<data name="category/data/parent_id/dataset" xsi:type="string">default_category</data>
<data name="category/data/is_active" xsi:type="string">Yes</data>
<data name="category/data/include_in_menu" xsi:type="string">Yes</data>
<data name="category/data/name" xsi:type="string">Subcategory%isolation%</data>
<data name="category/data/category_products/dataset" xsi:type="string">catalogProductSimple::default, catalogProductSimple::not_visible_individually</data>
<constraint name="Magento\Catalog\Test\Constraint\AssertCategorySaveMessage" />
<constraint name="Magento\Catalog\Test\Constraint\AssertCategoryProductsGridFilter" />
</variation>
</testCase>
</config>