Filtering a Magento 2 Object Repository
-
13-12-2019 - |
Question
In Magento 2, can you use a product repository to filter by product attributes?
In Magento 2, you can use a search criteria object
\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria,
and a repository
\Magento\Catalog\Api\ProductRepositoryInterface $productRepository,
To fetch a list of objects
$searchCriteria->getPageSize(10);
$list = $productRepository->getList($searchCriteria);
However, the searchCriteria object doesn't (seem to?) have direct filtering capabilities. The search criteria class does have methods for adding something called filterGroups
#File: lib/internal/Magento/Framework/Api/SearchCriteria.php
public function getFilterGroups()
{
$filterGroups = $this->_get(self::FILTER_GROUPS);
return is_array($filterGroups) ? $filterGroups : [];
}
public function setFilterGroups(array $filterGroups = null)
{
return $this->setData(self::FILTER_GROUPS, $filterGroups);
}
But it's not clear what, exactly, a filter group is thanks to PHP's untyped arrays.
How can I use a Magento 2 repository to do things like
- Show me all the products with [this specific SKU]
- Show me all the products created after [this date]
- etc.
Solution
Check out the following sample class. To filter by SKU, try this:
$productFilterDemo->getProducts('sku', 'product_sku_value', 'eq');
To get products created after specific date, this:
$productFilterDemo->getProducts('created_at', 'creation date', 'gt');
Sample class:
<?php
namespace Vendor\ModlueName\Model;
use Magento\Framework\Api\SearchCriteriaBuilder;
use Magento\Catalog\Api\ProductRepositoryInterface;
class ProductFilterDemo
{
/** @var ProductRepositoryInterface */
protected $productRepository;
/** @var SearchCriteriaBuilder */
protected $searchCriteriaBuilder;
/**
* Initialize dependencies.
*
* @param ProductRepositoryInterface $productRepository
* @param SearchCriteriaBuilder $searchCriteriaBuilder
*/
public function __construct(
ProductRepositoryInterface $productRepository,
SearchCriteriaBuilder $searchCriteriaBuilder
) {
$this->productRepository = $productRepository;
$this->searchCriteriaBuilder = $searchCriteriaBuilder;
}
/**
* Get products with filter.
*
* @param string $fieldName
* @param string $fieldValue
* @param string $filterType
* @return \Magento\Catalog\Api\Data\ProductInterface[]
*/
public function getProducts($fieldName, $fieldValue, $filterType)
{
$searchCriteria = $this->searchCriteriaBuilder->addFilter($fieldName, $fieldValue, $filterType)->create();
$products = $this->productRepository->getList($searchCriteria);
return $products->getItems();
}
}
OTHER TIPS
public function __construct(
ProductRepositoryInterface $productRepository,
SearchCriteriaBuilder $searchCriteriaBuilder,
FilterBuilder $filterBuilder,
) {
$this->productRepository = $productRepository;
$this->searchCriteriaBuilder = $searchCriteriaBuilder;
$this->filterBuilder = $filterBuilder;
}
public function getProducts()
{
$filters[] = $this->filterBuilder
->setField('sku')
->setConditionType('eq')
->setValue('something')
->create();
$this->searchCriteriaBuilder->addFilters($filters);
$searchCriteria = $this->searchCriteriaBuilder->create();
$searchResults = $this->productRepository->getList($searchCriteria);
return $searchResults->getItems();
}
Licensed under: CC-BY-SA with attribution
Not affiliated with magento.stackexchange