Inheritance diagram for Layer:

Public Member Functions
	__construct (\Magento\Catalog\Model\Layer\ContextInterface $context, \Magento\Catalog\Model\Layer\StateFactory $layerStateFactory, AttributeCollectionFactory $attributeCollectionFactory, \Magento\Catalog\Model\ResourceModel\Product $catalogProduct, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Registry $registry, CategoryRepositoryInterface $categoryRepository, array $data=[])

	getStateKey ()

	getProductCollection ()

	prepareProductCollection ($collection)

	apply ()

	getCurrentCategory ()

	setCurrentCategory ($category)

	getCurrentStore ()

	getState ()

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)

Protected Attributes
	$_productCollections = []

	$_stateKey = null

	$registry = null

	$_storeManager

	$_catalogProduct

	$_attributeCollectionFactory

	$_layerStateFactory

	$collectionProvider

	$stateKeyGenerator

	$collectionFilter

	$categoryRepository

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Catalog view layer model

@api @SuppressWarnings(PHPMD.LongVariable) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 20 of file Layer.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Catalog\Model\Layer\ContextInterface	$context,
		\Magento\Catalog\Model\Layer\StateFactory	$layerStateFactory,
		AttributeCollectionFactory	$attributeCollectionFactory,
		\Magento\Catalog\Model\ResourceModel\Product	$catalogProduct,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\Registry	$registry,
		CategoryRepositoryInterface	$categoryRepository,
		array	$data = `[]`
	)

Parameters

Layer\ContextInterface	$context
Layer\StateFactory	$layerStateFactory
AttributeCollectionFactory	$attributeCollectionFactory
\Magento\Catalog\Model\ResourceModel\Product	$catalogProduct
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\Registry	$registry
CategoryRepositoryInterface	$categoryRepository
array	$data

Definition at line 101 of file Layer.php.

       {
         $this->_layerStateFactory = $layerStateFactory;
         $this->_attributeCollectionFactory = $attributeCollectionFactory;
         $this->_catalogProduct = $catalogProduct;
         $this->_storeManager = $storeManager;
         $this->registry = $registry;
         $this->categoryRepository = $categoryRepository;
         $this->collectionProvider = $context->getCollectionProvider();
         $this->stateKeyGenerator = $context->getStateKey();
         $this->collectionFilter = $context->getCollectionFilter();
         parent::__construct($data);
     }

Member Function Documentation

◆ apply()

apply ( )

Apply layer Method is colling after apply all filters, can be used for prepare some index data before getting information about existing indexes

Returns: \Magento\Catalog\Model\Layer

Definition at line 175 of file Layer.php.

     {
         $stateSuffix = '';
         foreach ($this->getState()->getFilters() as $filterItem) {
             $stateSuffix .= '_' . $filterItem->getFilter()->getRequestVar() . '_' . $filterItem->getValueString();
         }
         if (!empty($stateSuffix)) {
             $this->_stateKey = $this->getStateKey() . $stateSuffix;
         }
 
         return $this;
     }

◆ getCurrentCategory()

getCurrentCategory ( )

Retrieve current category model If no category found in registry, the root will be taken

Returns: \Magento\Catalog\Model\Category

Definition at line 194 of file Layer.php.

     {
         $category = $this->getData('current_category');
         if ($category === null) {
             $category = $this->registry->registry('current_category');
             if ($category) {
                 $this->setData('current_category', $category);
             } else {
                 $category = $this->categoryRepository->get($this->getCurrentStore()->getRootCategoryId());
                 $this->setData('current_category', $category);
             }
         }
 
         return $category;
     }

◆ getCurrentStore()

getCurrentStore ( )

Retrieve current store model

Returns: \Magento\Store\Model\Store

Definition at line 247 of file Layer.php.

     {
         return $this->_storeManager->getStore();
     }

◆ getProductCollection()

getProductCollection ( )

Retrieve current layer product collection

Returns: \Magento\Catalog\Model\ResourceModel\Product\Collection

Definition at line 141 of file Layer.php.

     {
         if (isset($this->_productCollections[$this->getCurrentCategory()->getId()])) {
             $collection = $this->_productCollections[$this->getCurrentCategory()->getId()];
         } else {
             $collection = $this->collectionProvider->getCollection($this->getCurrentCategory());
             $this->prepareProductCollection($collection);
             $this->_productCollections[$this->getCurrentCategory()->getId()] = $collection;
         }
 
         return $collection;
     }

◆ getState()

getState ( )

Retrieve layer state object

Returns: \Magento\Catalog\Model\Layer\State

Definition at line 257 of file Layer.php.

     {
         $state = $this->getData('state');
         if ($state === null) {
             \Magento\Framework\Profiler::start(__METHOD__);
             $state = $this->_layerStateFactory->create();
             $this->setData('state', $state);
             \Magento\Framework\Profiler::stop(__METHOD__);
         }
 
         return $state;
     }

◆ getStateKey()

getStateKey ( )

Get layer state key

Returns: string

Definition at line 128 of file Layer.php.

     {
         if (!$this->_stateKey) {
             $this->_stateKey = $this->stateKeyGenerator->toString($this->getCurrentCategory());
         }
         return $this->_stateKey;
     }

◆ prepareProductCollection()

prepareProductCollection ( $collection )

Initialize product collection

Parameters

\Magento\Catalog\Model\ResourceModel\Product\Collection $collection

Returns: \Magento\Catalog\Model\Layer

Definition at line 160 of file Layer.php.

     {
         $this->collectionFilter->filter($collection, $this->getCurrentCategory());
 
         return $this;
     }

◆ setCurrentCategory()

setCurrentCategory ( $category )

Change current category object

Parameters

mixed $category

Returns: \Magento\Catalog\Model\Layer

Exceptions

Definition at line 217 of file Layer.php.

     {
         if (is_numeric($category)) {
             try {
                 $category = $this->categoryRepository->get($category);
             } catch (NoSuchEntityException $e) {
                 throw new \Magento\Framework\Exception\LocalizedException(__('Please correct the category.'), $e);
             }
         } elseif ($category instanceof \Magento\Catalog\Model\Category) {
             if (!$category->getId()) {
                 throw new \Magento\Framework\Exception\LocalizedException(__('Please correct the category.'));
             }
         } else {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __('Must be category model instance or its id.')
             );
         }
 
         if ($category->getId() != $this->getCurrentCategory()->getId()) {
             $this->setData('current_category', $category);
         }
 
         return $this;
     }

Field Documentation

◆ $_attributeCollectionFactory

$_attributeCollectionFactory

protected

Definition at line 62 of file Layer.php.

◆ $_catalogProduct

$_catalogProduct

protected

Definition at line 55 of file Layer.php.

◆ $_layerStateFactory

$_layerStateFactory

protected

Definition at line 69 of file Layer.php.

◆ $_productCollections

$_productCollections = []

protected

Definition at line 27 of file Layer.php.

◆ $_stateKey

$_stateKey = null

protected

Definition at line 34 of file Layer.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 48 of file Layer.php.

◆ $categoryRepository

$categoryRepository

protected

Definition at line 89 of file Layer.php.

◆ $collectionFilter

$collectionFilter

protected

Definition at line 84 of file Layer.php.

◆ $collectionProvider

$collectionProvider

protected

Definition at line 74 of file Layer.php.

◆ $registry

$registry = null

protected

Definition at line 41 of file Layer.php.

◆ $stateKeyGenerator

$stateKeyGenerator

protected

Definition at line 79 of file Layer.php.

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ apply()

◆ getCurrentCategory()

◆ getCurrentStore()

◆ getProductCollection()

◆ getState()

◆ getStateKey()

◆ prepareProductCollection()

◆ setCurrentCategory()

Field Documentation

◆ $_attributeCollectionFactory

◆ $_catalogProduct

◆ $_layerStateFactory

◆ $_productCollections

◆ $_stateKey

◆ $_storeManager

◆ $categoryRepository

◆ $collectionFilter

◆ $collectionProvider

◆ $registry

◆ $stateKeyGenerator