FilterModifier.php

Go to the documentation of this file.

<?php
namespace Magento\Ui\Component\Filters;

use Magento\Framework\View\Element\UiComponent\DataProvider\DataProviderInterface;
use Magento\Framework\App\RequestInterface;
use Magento\Framework\Api\FilterBuilder;

class FilterModifier
{
    const FILTER_MODIFIER = 'filters_modifier';

    protected $request;

    protected $filterBuilder;

    protected $allowedConditionTypes;

    public function __construct(RequestInterface $request, FilterBuilder $filterBuilder, $allowedConditionTypes = [])
    {
        $this->request = $request;
        $this->filterBuilder = $filterBuilder;
        $this->allowedConditionTypes = array_merge(
            ['eq', 'neq', 'in', 'nin', 'null', 'notnull'],
            $allowedConditionTypes
        );
    }

    public function applyFilterModifier(DataProviderInterface $dataProvider, $filterName)
    {
        $filterModifier = $this->request->getParam(self::FILTER_MODIFIER);
        if (isset($filterModifier[$filterName]['condition_type'])) {
            $conditionType = $filterModifier[$filterName]['condition_type'];
            if (!in_array($conditionType, $this->allowedConditionTypes)) {
                throw new \Magento\Framework\Exception\LocalizedException(
                    __('Condition type "%1" is not allowed', $conditionType)
                );
            }
            $value = isset($filterModifier[$filterName]['value'])
                ? $filterModifier[$filterName]['value']
                : null;
            $filter = $this->filterBuilder->setConditionType($conditionType)
                ->setField($filterName)
                ->setValue($value)
                ->create();
            $dataProvider->addFilter($filter);
        }
    }
}