PHP Class Smile\ElasticsuiteCatalog\Model\Layer\Filter\Category

Author: Aurelien FOUCRET ([email protected])
Inheritance: extends Magento\CatalogSearch\Model\Layer\Filter\Category, implements Smile\ElasticsuiteCatalog\Model\Layer\Filter\FilterInterface
Show file Open project: smile-sa/elasticsuite Class Usage Examples

Public Methods

Method Description
__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 $dataProviderFactory, boolean $useUrlRewrites = false, array $data = [] ) Constructor.
addFacetToCollection ( $config = [] ) {@inheritDoc}
apply ( Magento\Framework\App\RequestInterface $request ) {@inheritDoc}

Protected Methods

Method Description
_getItemsData ( )
_initItems ( )
applyCategoryFilterToCollection ( Magento\Catalog\Api\Data\CategoryInterface $category ) Apply the category filter to the layer product collection.
getChildrenCategories ( ) : Magento\Catalog\Model\ResourceModel\Category\Collection | Magento\Catalog\Model\Category[] Retrieve currently selected category children categories.
getDataProvider ( ) : Magento\Catalog\Model\Layer\Filter\DataProvider\Category Category data provider.
getFilterField ( ) : string Retrieve ES filter field.
useUrlRewrites ( ) : boolean Indicates if the filter uses url rewrites or not.

Method Details

__construct() public method

Constructor.
public __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 $dataProviderFactory, boolean $useUrlRewrites = false, array $data = [] )
$filterItemFactory Magento\Catalog\Model\Layer\Filter\ItemFactory Filter item factory.
$storeManager Magento\Store\Model\StoreManagerInterface Store manager.
$layer Magento\Catalog\Model\Layer Search layer.
$itemDataBuilder Magento\Catalog\Model\Layer\Filter\Item\DataBuilder Item data builder.
$escaper Magento\Framework\Escaper HTML escaper.
$dataProviderFactory Magento\Catalog\Model\Layer\Filter\DataProvider\CategoryFactory Data provider.
$useUrlRewrites boolean Uses URLs rewrite for rendering.
$data array Custom data.

_getItemsData() protected method

protected _getItemsData ( )

_initItems() protected method

protected _initItems ( )

addFacetToCollection() public method

{@inheritDoc}
public addFacetToCollection ( $config = [] )

apply() public method

{@inheritDoc}
public apply ( Magento\Framework\App\RequestInterface $request )
$request Magento\Framework\App\RequestInterface

applyCategoryFilterToCollection() protected method

Apply the category filter to the layer product collection.
protected applyCategoryFilterToCollection ( Magento\Catalog\Api\Data\CategoryInterface $category )
$category Magento\Catalog\Api\Data\CategoryInterface Category.

getChildrenCategories() protected method

Retrieve currently selected category children categories.
protected getChildrenCategories ( ) : Magento\Catalog\Model\ResourceModel\Category\Collection | Magento\Catalog\Model\Category[]
return Magento\Catalog\Model\ResourceModel\Category\Collection | Magento\Catalog\Model\Category[]

getDataProvider() protected method

Category data provider.
protected getDataProvider ( ) : Magento\Catalog\Model\Layer\Filter\DataProvider\Category
return Magento\Catalog\Model\Layer\Filter\DataProvider\Category

getFilterField() protected method

Retrieve ES filter field.
protected getFilterField ( ) : string
return string

useUrlRewrites() protected method

Indicates if the filter uses url rewrites or not.
protected useUrlRewrites ( ) : boolean
return boolean