FilterList Class Reference

Public Member Functions
	__construct (\Magento\Framework\ObjectManagerInterface $objectManager, FilterableAttributeListInterface $filterableAttributes, array $filters=[])
	getFilters (\Magento\Catalog\Model\Layer $layer)

Data Fields
const	CATEGORY_FILTER = 'category'
const	ATTRIBUTE_FILTER = 'attribute'
const	PRICE_FILTER = 'price'
const	DECIMAL_FILTER = 'decimal'

Protected Member Functions
	createAttributeFilter (\Magento\Catalog\Model\ResourceModel\Eav\Attribute $attribute, \Magento\Catalog\Model\Layer $layer)
	getAttributeFilterClass (\Magento\Catalog\Model\ResourceModel\Eav\Attribute $attribute)

Protected Attributes
	$objectManager
	$filterableAttributes
	$filterTypes
	$filters = []

Detailed Description

Definition at line 9 of file FilterList.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\ObjectManagerInterface	$objectManager,
		FilterableAttributeListInterface	$filterableAttributes,
		array	$filters = []
	)

Parameters

\Magento\Framework\ObjectManagerInterface	$objectManager
FilterableAttributeListInterface	$filterableAttributes
array	$filters

Override default filter type models

Definition at line 48 of file FilterList.php.

      {
        $this->objectManager = $objectManager;
        $this->filterableAttributes = $filterableAttributes;

        $this->filterTypes = array_merge($this->filterTypes, $filters);
    }

Member Function Documentation

createAttributeFilter()

createAttributeFilter ( \Magento\Catalog\Model\ResourceModel\Eav\Attribute  $attribute, \Magento\Catalog\Model\Layer  $layer  )

protected

Create filter

Parameters

\Magento\Catalog\Model\ResourceModel\Eav\Attribute	$attribute
\Magento\Catalog\Model\Layer	$layer

Returns

\Magento\Catalog\Model\Layer\Filter\AbstractFilter

Definition at line 86 of file FilterList.php.

      {
        $filterClassName = $this->getAttributeFilterClass($attribute);

        $filter = $this->objectManager->create(
            $filterClassName,
            ['data' => ['attribute_model' => $attribute], 'layer' => $layer]
        );
        return $filter;
    }

getAttributeFilterClass()

getAttributeFilterClass ( \Magento\Catalog\Model\ResourceModel\Eav\Attribute  $attribute )

protected

Get Attribute Filter Class Name

Parameters

\Magento\Catalog\Model\ResourceModel\Eav\Attribute

$attribute

Returns

string

Definition at line 105 of file FilterList.php.

    {
        $filterClassName = $this->filterTypes[self::ATTRIBUTE_FILTER];

        if ($attribute->getAttributeCode() == 'price') {
            $filterClassName = $this->filterTypes[self::PRICE_FILTER];
        } elseif ($attribute->getBackendType() == 'decimal') {
            $filterClassName = $this->filterTypes[self::DECIMAL_FILTER];
        }

        return $filterClassName;
    }

getFilters()

getFilters

(

\Magento\Catalog\Model\Layer

$layer

)

Retrieve list of filters

Parameters

\Magento\Catalog\Model\Layer

$layer

Returns

array|Filter\AbstractFilter[]

Definition at line 66 of file FilterList.php.

    {
        if (!count($this->filters)) {
            $this->filters = [
                $this->objectManager->create($this->filterTypes[self::CATEGORY_FILTER], ['layer' => $layer]),
            ];
            foreach ($this->filterableAttributes->getList() as $attribute) {
                $this->filters[] = $this->createAttributeFilter($attribute, $layer);
            }
        }
        return $this->filters;
    }

Field Documentation

$filterableAttributes

$filterableAttributes

protected

Definition at line 26 of file FilterList.php.

$filters

$filters = []

protected

Definition at line 41 of file FilterList.php.

$filterTypes

$filterTypes

protected

Initial value:

= [
        self::CATEGORY_FILTER  => \Magento\Catalog\Model\Layer\Filter\Category::class,
        self::ATTRIBUTE_FILTER => \Magento\Catalog\Model\Layer\Filter\Attribute::class,
        self::PRICE_FILTER     => \Magento\Catalog\Model\Layer\Filter\Price::class,
        self::DECIMAL_FILTER   => \Magento\Catalog\Model\Layer\Filter\Decimal::class,
    ]

Definition at line 31 of file FilterList.php.

$objectManager

$objectManager

protected

Definition at line 21 of file FilterList.php.

ATTRIBUTE_FILTER

const ATTRIBUTE_FILTER = 'attribute'

Definition at line 12 of file FilterList.php.

CATEGORY_FILTER

const CATEGORY_FILTER = 'category'

Definition at line 11 of file FilterList.php.

DECIMAL_FILTER

const DECIMAL_FILTER = 'decimal'

Definition at line 14 of file FilterList.php.

PRICE_FILTER

const PRICE_FILTER = 'price'

Definition at line 13 of file FilterList.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-catalog/Model/Layer/FilterList.php