Category Class Reference

Inheritance diagram for Category:

Public Member Functions
	__construct (\Magento\Catalog\Model\Layer\Filter\ItemFactory $filterItemFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Catalog\Model\Layer $layer, \Magento\Catalog\Model\Layer\Filter\Item\DataBuilder $itemDataBuilder, \Magento\Framework\Escaper $escaper, \Magento\Catalog\Model\Layer\Filter\DataProvider\CategoryFactory $categoryDataProviderFactory, array $data=[])
	apply (\Magento\Framework\App\RequestInterface $request)
	getResetValue ()
	getName ()
Public Member Functions inherited from AbstractFilter
	__construct (\Magento\Catalog\Model\Layer\Filter\ItemFactory $filterItemFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Catalog\Model\Layer $layer, \Magento\Catalog\Model\Layer\Filter\Item\DataBuilder $itemDataBuilder, array $data=[])
	setRequestVar ($varName)
	getRequestVar ()
	getResetValue ()
	getCleanValue ()
	apply (\Magento\Framework\App\RequestInterface $request)
	getItemsCount ()
	getItems ()
	setItems (array $items)
	getLayer ()
	setAttributeModel ($attribute)
	getAttributeModel ()
	getName ()
	getStoreId ()
	setStoreId ($storeId)
	getWebsiteId ()
	setWebsiteId ($websiteId)
	getClearLinkText ()
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)

Additional Inherited Members
Data Fields inherited from AbstractFilter
const	ATTRIBUTE_OPTIONS_ONLY_WITH_RESULTS = 1
Protected Member Functions inherited from AbstractFilter
	_getItemsData ()
	_initItems ()
	_createItem ($label, $value, $count=0)
	_getFilterEntityIds ()
	_getBaseCollectionSql ()
	getOptionText ($optionId)
	getAttributeIsFilterable ($attribute)
	isOptionReducesResults ($optionCount, $totalSize)
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)
Protected Attributes inherited from AbstractFilter
	$_requestVar
	$_items
	$_catalogLayer
	$_storeManager
	$_filterItemFactory
	$itemDataBuilder
Protected Attributes inherited from DataObject
	$_data = []
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Layer category filter

Definition at line 14 of file Category.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Catalog\Model\Layer\Filter\ItemFactory	$filterItemFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Catalog\Model\Layer	$layer,
		\Magento\Catalog\Model\Layer\Filter\Item\DataBuilder	$itemDataBuilder,
		\Magento\Framework\Escaper	$escaper,
		\Magento\Catalog\Model\Layer\Filter\DataProvider\CategoryFactory	$categoryDataProviderFactory,
		array	$data = []
	)

Category constructor.

Parameters

\Magento\Catalog\Model\Layer\Filter\ItemFactory	$filterItemFactory
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Catalog\Model\Layer	$layer
\Magento\Catalog\Model\Layer\Filter\Item\DataBuilder	$itemDataBuilder
\Magento\Framework\Escaper	$escaper
\Magento\Catalog\Model\Layer\Filter\DataProvider\CategoryFactory	$categoryDataProviderFactory
array	$data

Exceptions

Definition at line 38 of file Category.php.

      {
        parent::__construct(
            $filterItemFactory,
            $storeManager,
            $layer,
            $itemDataBuilder,
            $data
        );
        $this->escaper = $escaper;
        $this->_requestVar = 'cat';
        $this->dataProvider = $categoryDataProviderFactory->create(['layer' => $this->getLayer()]);
    }

Member Function Documentation

apply()

apply

(

\Magento\Framework\App\RequestInterface

$request

)

Apply category filter to product collection

Parameters

\Magento\Framework\App\RequestInterface

$request

Returns

$this

Implements FilterInterface.

Definition at line 65 of file Category.php.

    {
        $categoryId = $request->getParam($this->_requestVar) ?: $request->getParam('id');
        if (empty($categoryId)) {
            return $this;
        }

        $this->dataProvider->setCategoryId($categoryId);

        $category = $this->dataProvider->getCategory();

        $this->getLayer()->getProductCollection()->addCategoryFilter($category);

        if ($request->getParam('id') != $category->getId() && $this->dataProvider->isValid()) {
            $this->getLayer()->getState()->addFilter($this->_createItem($category->getName(), $categoryId));
        }
        return $this;
    }

getName()

getName

(

)

Get filter name

Returns

\Magento\Framework\Phrase

Implements FilterInterface.

Definition at line 99 of file Category.php.

    {
        return __('Category');
    }

getResetValue()

getResetValue

(

)

Get filter value for reset current filter state

Returns

mixed|null

Implements FilterInterface.

Definition at line 89 of file Category.php.

    {
        return $this->dataProvider->getResetValue();
    }

---

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

• vendor/magento/module-catalog-search/Model/Layer/Filter/Category.php