vendor/pimcore/pimcore/bundles/EcommerceFrameworkBundle/FilterService/FilterService.php line 78

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Bundle\EcommerceFrameworkBundle\FilterService;
  18. use Pimcore\Bundle\EcommerceFrameworkBundle\FilterService\Exception\FilterTypeNotFoundException;
  19. use Pimcore\Bundle\EcommerceFrameworkBundle\FilterService\FilterType\AbstractFilterType;
  20. use Pimcore\Bundle\EcommerceFrameworkBundle\IndexService\ProductList\ProductListInterface;
  21. use Pimcore\Bundle\EcommerceFrameworkBundle\Model\AbstractFilterDefinition;
  22. use Pimcore\Bundle\EcommerceFrameworkBundle\Model\AbstractFilterDefinitionType;
  24. class FilterService
  25. {
  26.     /**
  27.      * @var FilterGroupHelper
  28.      */
  29.     protected $filterGroupHelper;
  31.     /**
  32.      * @var AbstractFilterType[]
  33.      */
  34.     protected $filterTypes = [];
  36.     /**
  37.      * @param FilterGroupHelper $filterGroupHelper
  38.      * @param AbstractFilterType[] $filterTypes
  39.      */
  40.     public function __construct(FilterGroupHelper $filterGroupHelper, array $filterTypes)
  41.     {
  42.         $this->filterGroupHelper = $filterGroupHelper;
  44.         foreach ($filterTypes as $name => $filterType) {
  45.             $this->registerFilterType($name, $filterType);
  46.         }
  47.     }
  49.     protected function registerFilterType(string $name, AbstractFilterType $filterType)
  50.     {
  51.         $this->filterTypes[$name] = $filterType;
  52.     }
  54.     public function getFilterType(string $name): AbstractFilterType
  55.     {
  56.         if (!isset($this->filterTypes[$name])) {
  57.             throw new FilterTypeNotFoundException(sprintf('Filter type "%s" is not registered', $name));
  58.         }
  60.         return $this->filterTypes[$name];
  61.     }
  63.     public function getFilterGroupHelper(): FilterGroupHelper
  64.     {
  65.         return $this->filterGroupHelper;
  66.     }
  68.     /**
  69.      * Initializes the FilterService, adds all conditions to the ProductList and returns an array of the currently set
  70.      * filters
  71.      *
  72.      * @param AbstractFilterDefinition $filterObject filter definition object to use
  73.      * @param ProductListInterface $productList              product list to use and add conditions to
  74.      * @param array $params                          request params with eventually set filter conditions
  75.      *
  76.      * @return array returns set filters
  77.      */
  78.     public function initFilterService(AbstractFilterDefinition $filterObject, ProductListInterface $productList, $params = [])
  79.     {
  80.         $currentFilter = [];
  82.         if ($filterObject->getFilters()) {
  83.             foreach ($filterObject->getFilters() as $filter) {
  84.                 $currentFilter = $this->addCondition($filter, $productList, $currentFilter, $params);
  85.             }
  86.             //do this in a separate loop in order to make sure that all filters are set when group by values are prepared
  87.             foreach ($filterObject->getFilters() as $filter) {
  88.                 //prepare group by filters
  89.                 $this->getFilterType($filter->getType())->prepareGroupByValues($filter, $productList);
  90.             }
  91.         }
  93.         if ($filterObject->getConditions()) {
  94.             foreach ($filterObject->getConditions() as $condition) {
  95.                 $this->addCondition($condition, $productList, $currentFilter, [], true);
  96.             }
  97.         }
  99.         return $currentFilter;
  100.     }
  102.     /**
  103.      * Returns filter frontend script for given filter type (delegates)
  104.      *
  105.      * @param AbstractFilterDefinitionType $filterDefinition filter definition to get frontend script for
  106.      * @param ProductListInterface $productList current product list (with all set filters) to get available options and counts
  107.      * @param array $currentFilter current filter for this filter definition
  108.      *
  109.      * @return string view snippet
  110.      */
  111.     public function getFilterFrontend(AbstractFilterDefinitionType $filterDefinition, ProductListInterface $productList, $currentFilter)
  112.     {
  113.         return $this
  114.             ->getFilterType($filterDefinition->getType())
  115.             ->getFilterFrontend($filterDefinition, $productList, $currentFilter);
  116.     }
  118.     /**
  119.      * Returns filter data for given filter type (delegates)
  120.      *
  121.      * @param AbstractFilterDefinitionType $filterDefinition filter definition to get frontend script for
  122.      * @param ProductListInterface $productList current product list (with all set filters) to get available options and counts
  123.      * @param array $currentFilter current filter for this filter definition
  124.      *
  125.      * @return array
  126.      */
  127.     public function getFilterValues(AbstractFilterDefinitionType $filterDefinition, ProductListInterface $productList, array $currentFilter): array
  128.     {
  129.         return $this
  130.             ->getFilterType($filterDefinition->getType())
  131.             ->getFilterValues($filterDefinition, $productList, $currentFilter);
  132.     }
  134.     /**
  135.      * Adds condition - delegates it to the AbstractFilterType instance
  136.      *
  137.      * @param AbstractFilterDefinitionType $filterDefinition
  138.      * @param ProductListInterface $productList
  139.      * @param array $currentFilter
  140.      * @param array $params
  141.      * @param bool $isPrecondition
  142.      *
  143.      * @return array updated currentFilter array
  144.      */
  145.     public function addCondition(AbstractFilterDefinitionType $filterDefinition, ProductListInterface $productList, $currentFilter, $params, $isPrecondition = false)
  146.     {
  147.         return $this
  148.             ->getFilterType($filterDefinition->getType())
  149.             ->addCondition($filterDefinition, $productList, $currentFilter, $params, $isPrecondition);
  150.     }
  151. }