Skip to content

Added custom filter "ProductStoreFilter" for Catalog Product API to enable store-filtering via REST API #8123

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

Closed
wants to merge 1 commit into from
Closed
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
@@ -0,0 +1,32 @@
<?php
/**
* Copyright © 2013-2017 Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Catalog\Model\Api\SearchCriteria\CollectionProcessor\FilterProcessor;

use Magento\Catalog\Model\ResourceModel\Product\Collection;
use Magento\Framework\Api\Filter;
use Magento\Framework\Api\SearchCriteria\CollectionProcessor\FilterProcessor\CustomFilterInterface;
use Magento\Framework\Data\Collection\AbstractDb;

class ProductStoreFilter implements CustomFilterInterface
{
/**
* Apply store Filter to Product Collection
*
* @param Filter $filter
* @param AbstractDb $collection
* @return bool Whether the filter is applied
*/
public function apply(Filter $filter, AbstractDb $collection)
{
$conditionType = $filter->getConditionType() ? $filter->getConditionType() : 'eq';
$storeFilter = [$conditionType => [$filter->getValue()]];

/** @var Collection $collection */
$collection->addStoreFilter($storeFilter);

return true;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<?php
/**
* Copyright © 2013-2017 Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Catalog\Test\Unit\Model\Api\SearchCriteria\CollectionProcessor\FilterProcessor;

use Magento\Catalog\Model\Api\SearchCriteria\CollectionProcessor\FilterProcessor\ProductStoreFilter;
use Magento\Catalog\Model\ResourceModel\Product\Collection;
use Magento\Framework\Api\Filter;

class ProductStoreFilterTest extends \PHPUnit_Framework_TestCase
{
/** @var ProductStoreFilter */
private $model;

protected function setUp()
{
$this->model = new ProductStoreFilter();
}

public function testApply()
{
/** @var Filter|\PHPUnit_Framework_MockObject_MockObject $filterMock */
$filterMock = $this->getMockBuilder(Filter::class)
->disableOriginalConstructor()
->getMock();

/** @var Collection|\PHPUnit_Framework_MockObject_MockObject $collectionMock */
$collectionMock = $this->getMockBuilder(Collection::class)
->disableOriginalConstructor()
->getMock();

$filterMock->expects($this->exactly(2))
->method('getConditionType')
->willReturn('condition');
$filterMock->expects($this->once())
->method('getValue')
->willReturn('value');

$collectionMock->expects($this->once())
->method('addStoreFilter')
->with(['condition' => ['value']]);

$this->assertTrue($this->model->apply($filterMock, $collectionMock));
}

public function testApplyWithoutCondition()
{
/** @var Filter|\PHPUnit_Framework_MockObject_MockObject $filterMock */
$filterMock = $this->getMockBuilder(Filter::class)
->disableOriginalConstructor()
->getMock();

/** @var Collection|\PHPUnit_Framework_MockObject_MockObject $collectionMock */
$collectionMock = $this->getMockBuilder(Collection::class)
->disableOriginalConstructor()
->getMock();

$filterMock->expects($this->once())
->method('getConditionType')
->willReturn(null);
$filterMock->expects($this->once())
->method('getValue')
->willReturn('value');

$collectionMock->expects($this->once())
->method('addStoreFilter')
->with(['eq' => ['value']]);

$this->assertTrue($this->model->apply($filterMock, $collectionMock));
}
}
1 change: 1 addition & 0 deletions app/code/Magento/Catalog/etc/di.xml
Original file line number Diff line number Diff line change
Expand Up @@ -826,6 +826,7 @@
<arguments>
<argument name="customFilters" xsi:type="array">
<item name="category_id" xsi:type="object">Magento\Catalog\Model\Api\SearchCriteria\CollectionProcessor\FilterProcessor\ProductCategoryFilter</item>
<item name="store" xsi:type="object">Magento\Catalog\Model\Api\SearchCriteria\CollectionProcessor\FilterProcessor\ProductStoreFilter</item>
</argument>
</arguments>
</virtualType>
Expand Down