iCom\SolrClient\Query\Helper\Terms

Complexity

Total Complexity

11

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	3	1
A	separator()	0	6	1
A	cache()	0	6	2
A	method()	0	10	2
A	__construct()	0	12	3
A	toString()	0	9	2

<?php

declare(strict_types=1);

/*
 * This file is part of Solr Client Symfony package.
 *
 * (c) ingatlan.com Zrt. <fejlesztes@ingatlan.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace iCom\SolrClient\Query\Helper;

use iCom\SolrClient\Query\QueryHelper;

/**
 * Uses the Terms Query Parser.
 *
 * May be more efficient in some cases than using
 * the Standard Query Parser to generate a boolean
 * query since the default implementation method avoids scoring.
 *
 * @see https://lucene.apache.org/solr/guide/8_4/other-parsers.html#term-query-parser
 */
final class Terms implements QueryHelper
{
    private $params = [
        'f' => null,
        'method' => null,
        'separator' => null,
        'cache' => null,
    ];

    private $values;

    public function __construct(string $field, array $values)
    {
        if ('' === $field) {
            throw new \InvalidArgumentException('The "field" parameter can not be empty.');
        }

        if ([] === $values) {
            throw new \InvalidArgumentException('The "values" parameter can not be empty.');
        }

        $this->params['f'] = $field;
        $this->values = $values;
    }

    public static function create(string $field, array $values): self
    {
        return new self($field, $values);
    }

    public function separator(string $separator): self
    {
        $terms = clone $this;
        $terms->params['separator'] = $separator;

        return $terms;
    }

    public function method(string $method): self
    {
        if (!\in_array($method, $available = ['termsFilter', 'booleanQuery', 'automaton', 'docValuesTermsFilter'], true)) {
            throw new \InvalidArgumentException(sprintf('Available methods are: "%s"', implode('", "', $available)));
        }

        $terms = clone $this;
        $terms->params['method'] = $method;

        return $terms;
    }

    public function cache(bool $cache): self
    {
        $terms = clone $this;
        $terms->params['cache'] = $cache ? 'true' : 'false';

        return $terms;
    }

    public function toString(): string
    {
        $params = $this->params;

        if (null !== $params['separator']) {
            $params['separator'] = sprintf('"%s"', addslashes($separator = $params['separator']));
        }

        return sprintf('{!terms %s}%s', urldecode(http_build_query($params, '', ' ')), implode($separator ?? ',', $this->values));
    }
}