AdvancedFilterProcessor.php

Go to the documentation of this file.

<?php
declare(strict_types=1);

namespace Magento\Framework\Api\SearchCriteria\CollectionProcessor;

use Magento\Framework\Api\SearchCriteria\CollectionProcessorInterface;
use Magento\Framework\Api\SearchCriteriaInterface;
use Magento\Framework\Data\Collection\AbstractDb;
use Magento\Framework\Api\CombinedFilterGroup;
use Magento\Framework\Api\Filter;
use Magento\Framework\Api\SearchCriteria\CollectionProcessor\ConditionProcessor\CustomConditionInterface;
use Magento\Framework\Exception\InputException;
use Magento\Framework\Search\Adapter\Mysql\ConditionManager;
use Magento\Framework\Api\SearchCriteria\CollectionProcessor\ConditionProcessor\CustomConditionProviderInterface;
use Magento\Framework\Phrase;

class AdvancedFilterProcessor implements CollectionProcessorInterface
{
    private $customConditionProvider;

    private $defaultConditionProcessor;

    private $conditionManager;

    public function __construct(
        CustomConditionInterface $defaultConditionProcessor,
        ConditionManager $conditionManager,
        CustomConditionProviderInterface $customConditionProvider
    ) {
        $this->defaultConditionProcessor = $defaultConditionProcessor;
        $this->conditionManager = $conditionManager;
        $this->customConditionProvider = $customConditionProvider;
    }

    public function process(SearchCriteriaInterface $searchCriteria, AbstractDb $collection)
    {
        foreach ($searchCriteria->getFilterGroups() as $group) {
            $conditions = $this->getConditionsFromFilterGroup($group);
            $collection->getSelect()->where($conditions);
        }
    }

    private function getConditionsFromFilterGroup(CombinedFilterGroup $filterGroup): string
    {
        $conditions = [];

        foreach ($filterGroup->getFilters() as $filter) {
            if ($filter instanceof CombinedFilterGroup) {
                $conditions[] = $this->getConditionsFromFilterGroup($filter);
                continue;
            }

            if ($filter instanceof Filter) {
                $conditions[] = $this->getConditionsFromFilter($filter);
                continue;
            }

            throw new InputException(
                new Phrase('Undefined filter group "%1" passed in.', [get_class($filter)])
            );
        }

        return $this->conditionManager->wrapBrackets(
            $this->conditionManager->combineQueries($conditions, $filterGroup->getCombinationMode())
        );
    }

    private function getConditionsFromFilter(Filter $filter): string
    {
        if ($this->customConditionProvider->hasProcessorForField($filter->getField())) {
            $customProcessor = $this->customConditionProvider->getProcessorByField($filter->getField());
            return $customProcessor->build($filter);
        }

        return $this->defaultConditionProcessor->build($filter);
    }
}