How to filter an EAV or a flat collection (product, category, sales, etc.) with the addAttributeToFilter() method?

dmitry_fedyuk · April 14, 2016, 9:31am

Context: How to filter a database collection?

1. \Magento\Catalog\Model\ResourceModel\AbstractCollection::addAttributeToFilter()

magento/magento2/blob/072a1ae/app/code/Magento/Catalog/Model/ResourceModel/AbstractCollection.php#L83-L95


/**
 * Specify collection select filter by attribute value
 * Backward compatibility with EAV collection
 *
 * @param string|\Magento\Eav\Model\Entity\Attribute $attribute
 * @param array|int|string|null $condition
 * @return $this
 */
public function addAttributeToFilter($attribute, $condition = null)
{
    $this->addFieldToFilter($this->_attributeToField($attribute), $condition);
    return $this;
}

2. \Magento\Catalog\Model\ResourceModel\Category\Flat\Collection::addAttributeToFilter()

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Catalog/Model/ResourceModel/Category/Flat/Collection.php#L300-L314


/**
 * Emulate simple add attribute filter to collection
 *
 * @param string $attribute
 * @param null|string|array $condition
 * @return $this
 */
public function addAttributeToFilter($attribute, $condition = null)
{
    if (!is_string($attribute) || $condition === null) {
        return $this;
    }


    return $this->addFieldToFilter($attribute, $condition);
}

3. \Magento\Catalog\Model\ResourceModel\Product\Collection::addAttributeToFilter()

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Catalog/Model/ResourceModel/Product/Collection.php#L1447-L1456


/**
 * Add attribute to filter
 *
 * @param \Magento\Eav\Model\Entity\Attribute\AbstractAttribute|string $attribute
 * @param array $condition
 * @param string $joinType
 * @return $this
 * @SuppressWarnings(PHPMD.CyclomaticComplexity)
 */
public function addAttributeToFilter($attribute, $condition = null, $joinType = 'inner')

4. \Magento\Eav\Model\Entity\Collection\AbstractCollection::addAttributeToFilter()

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Eav/Model/Entity/Collection/AbstractCollection.php#L322-L340


/**
 * Add attribute filter to collection
 *
 * If $attribute is an array will add OR condition with following format:
 * array(
 *     array('attribute'=>'firstname', 'like'=>'test%'),
 *     array('attribute'=>'lastname', 'like'=>'test%'),
 * )
 *
 * @param \Magento\Eav\Model\Entity\Attribute\AttributeInterface|integer|string|array $attribute
 * @param null|string|array $condition
 * @param string $joinType
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 *
 * @see self::_getConditionSql for $condition
 * @SuppressWarnings(PHPMD.CyclomaticComplexity)
 */
public function addAttributeToFilter($attribute, $condition = null, $joinType = 'inner')

5. \Magento\Sales\Model\ResourceModel\Collection\AbstractCollection::addAttributeToFilter()

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Sales/Model/ResourceModel/Collection/AbstractCollection.php#L83-L95


/**
 * Specify collection select filter by attribute value
 * Backward compatibility with EAV collection
 *
 * @param string|\Magento\Eav\Model\Entity\Attribute $attribute
 * @param array|int|string|null $condition
 * @return $this
 */
public function addAttributeToFilter($attribute, $condition = null)
{
    $this->addFieldToFilter($this->_attributeToField($attribute), $condition);
    return $this;
}

Usages

1

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Backend/Block/Dashboard/Orders/Grid.php#L67-L75


if ($this->getParam('store')) {
    $collection->addAttributeToFilter('store_id', $this->getParam('store'));
} elseif ($this->getParam('website')) {
    $storeIds = $this->_storeManager->getWebsite($this->getParam('website'))->getStoreIds();
    $collection->addAttributeToFilter('store_id', ['in' => $storeIds]);
} elseif ($this->getParam('group')) {
    $storeIds = $this->_storeManager->getGroup($this->getParam('group'))->getStoreIds();
    $collection->addAttributeToFilter('store_id', ['in' => $storeIds]);
}

2

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Backend/Block/Dashboard/Tab/Customers/Most.php#L56-L65


if ($this->getParam('store')) {
    $collection->addAttributeToFilter('store_id', $this->getParam('store'));
    $storeFilter = 1;
} elseif ($this->getParam('website')) {
    $storeIds = $this->_storeManager->getWebsite($this->getParam('website'))->getStoreIds();
    $collection->addAttributeToFilter('store_id', ['in' => $storeIds]);
} elseif ($this->getParam('group')) {
    $storeIds = $this->_storeManager->getGroup($this->getParam('group'))->getStoreIds();
    $collection->addAttributeToFilter('store_id', ['in' => $storeIds]);
}

3

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Backend/Block/Dashboard/Tab/Customers/Newest.php#L56-L63


    $storeFilter = 1;
} elseif ($this->getParam('website')) {
    $storeIds = $this->_storeManager->getWebsite($this->getParam('website'))->getStoreIds();
    $collection->addAttributeToFilter('store_id', ['in' => $storeIds]);
} elseif ($this->getParam('group')) {
    $storeIds = $this->_storeManager->getGroup($this->getParam('group'))->getStoreIds();
    $collection->addAttributeToFilter('store_id', ['in' => $storeIds]);
}

4

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Bundle/Block/Adminhtml/Catalog/Product/Edit/Tab/Bundle/Option/Search/Grid.php#L99-L117


$collection = $this->_productFactory->create()->getCollection()->setOrder(
    'id'
)->addAttributeToSelect(
    'name'
)->addAttributeToSelect(
    'sku'
)->addAttributeToSelect(
    'price'
)->addAttributeToSelect(
    'attribute_set_id'
)->addAttributeToFilter(
    'entity_id',
    ['nin' => $this->_getSelectedProducts()]
)->addAttributeToFilter(
    'type_id',
    ['in' => $this->getAllowedSelectionTypes()]
)->addFilterByRequiredOptions()->addStoreFilter(
    \Magento\Store\Model\Store::DEFAULT_STORE_ID
);

5

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Bundle/Ui/DataProvider/Product/BundleDataProvider.php#L65-L68


$this->getCollection()->addAttributeToFilter(
    'type_id',
    $this->dataHelper->getAllowedSelectionTypes()
);

6

github.com

magento/magento2/blob/072a1ae/app/code/Magento/BundleImportExport/Model/Export/RowCustomizer.php#L127-L133


$productCollection->addAttributeToFilter(
    'entity_id',
    ['in' => $productIds]
)->addAttributeToFilter(
    'type_id',
    ['eq' => \Magento\Catalog\Model\Product\Type::TYPE_BUNDLE]
);

7

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Catalog/Block/Adminhtml/Category/Tree.php#L136-L146


$matchingNamesCollection->addAttributeToFilter(
    'name',
    ['like' => $escapedNamePart]
)->addAttributeToFilter(
    'entity_id',
    ['neq' => \Magento\Catalog\Model\Category::TREE_ROOT_ID]
)->addAttributeToSelect(
    'path'
)->setStoreId(
    $storeId
);

8

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Catalog/Block/Adminhtml/Category/Tree.php#L155-L162


$collection->addAttributeToFilter(
    'entity_id',
    ['in' => array_keys($shownCategoriesIds)]
)->addAttributeToSelect(
    ['name', 'is_active', 'parent_id']
)->setStoreId(
    $storeId
);

9

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Catalog/Block/Adminhtml/Product/Widget/Chooser.php#L253-L255


if ($productTypeId = $this->getProductTypeId()) {
    $collection->addAttributeToFilter('type_id', $productTypeId);
}

10

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Catalog/Block/Product/NewProduct.php#L122-L141


$collection = $this->_addProductAttributesAndPrices(
    $collection
)->addStoreFilter()->addAttributeToFilter(
    'news_from_date',
    [
        'or' => [
            0 => ['date' => true, 'to' => $todayEndOfDayDate],
            1 => ['is' => new \Zend_Db_Expr('null')],
        ]
    ],
    'left'
)->addAttributeToFilter(
    'news_to_date',
    [
        'or' => [
            0 => ['date' => true, 'from' => $todayStartOfDayDate],
            1 => ['is' => new \Zend_Db_Expr('null')],
        ]
    ],
    'left'

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Catalog/Block/Product/NewProduct.php#L142-L147


)->addAttributeToFilter(
    [
        ['attribute' => 'news_from_date', 'is' => new \Zend_Db_Expr('not null')],
        ['attribute' => 'news_to_date', 'is' => new \Zend_Db_Expr('not null')],
    ]
)->addAttributeToSort(

11

github.com

magento/magento2/blob/072a1ae/app/code/Magento/Catalog/Block/Product/ProductList/Promotion.php#L65-L65


$collection->addAttributeToFilter('promotion', 1)->addStoreFilter();

dmitry_fedyuk · April 14, 2016, 10:12am