ApacheSolrForTypo3\Solr\Domain\Search\Query\ParameterBuilder\Spellchecking

Complexity

Total Complexity

6

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	build()	0	15	2
A	fromTypoScriptConfiguration()	0	11	2
A	getEmpty()	0	4	1

<?php
namespace ApacheSolrForTypo3\Solr\Domain\Search\Query\ParameterBuilder;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2017 <timo.hund@dkd.de>
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

use ApacheSolrForTypo3\Solr\Domain\Search\Query\Query;
use ApacheSolrForTypo3\Solr\System\Configuration\TypoScriptConfiguration;

/**
 * The Spellchecking ParameterProvider is responsible to build the solr query parameters
 * that are needed for the spellchecking.
 *
 * @package ApacheSolrForTypo3\Solr\Domain\Search\Query\ParameterBuilder
 */
class Spellchecking extends AbstractDeactivatableParameterBuilder implements ParameterBuilder
{

    /**
     * @var int
     */
    protected $maxCollationTries = 0;

    /**
     * Spellchecking constructor.
     *
     * @param bool $isEnabled
     * @param int $maxCollationTries
     */
    public function __construct($isEnabled = false, int $maxCollationTries = 0)
    {
        $this->isEnabled = $isEnabled;
        $this->maxCollationTries = $maxCollationTries;
    }

    /**
     * @param Query $query
     * @return Query
     */
    public function build(Query $query): Query
    {
        if (!$this->isEnabled) {
            $query->getQueryParametersContainer()->removeMany(['spellcheck', 'spellcheck.collate', 'spellcheck.maxCollationTries']);
            return $query;
        }

        $spellcheckingParameters = [];
        $spellcheckingParameters['spellcheck'] = 'true';
        $spellcheckingParameters['spellcheck.collate'] = 'true';
        $spellcheckingParameters['spellcheck.maxCollationTries'] = $this->maxCollationTries;

        $query->getQueryParametersContainer()->merge($spellcheckingParameters);
        return $query;
    }

    /**
     * @param TypoScriptConfiguration $solrConfiguration
     * @return Spellchecking
     */
    public static function fromTypoScriptConfiguration(TypoScriptConfiguration $solrConfiguration)
    {
        $isEnabled = $solrConfiguration->getSearchSpellchecking();
        if (!$isEnabled) {
            return new Spellchecking(false);
        }

        $maxCollationTries = $solrConfiguration->getSearchSpellcheckingNumberOfSuggestionsToTry();

        return new Spellchecking($isEnabled, $maxCollationTries);
    }

    /**
     * @return Spellchecking
     */
    public static function getEmpty()
    {
        return new Spellchecking(false);
    }
}