Elastica\Suggest\Phrase

Complexity

Total Complexity

16

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	setAnalyzer()	0	4	1
A	setGramSize()	0	4	1
A	setRealWordErrorLikelihood()	0	4	1
A	setConfidence()	0	4	1
A	setMaxErrors()	0	4	1
A	setSeparator()	0	4	1
A	setHighlight()	0	7	1
A	setStupidBackoffSmoothing()	0	6	1
A	setLaplaceSmoothing()	0	6	1
A	setLinearInterpolationSmoothing()	0	8	1
A	setSmoothingModel()	0	6	1
A	addDirectGenerator()	0	4	1
A	addCandidateGenerator()	0	6	1
A	toArray()	0	20	3

<?php

namespace Elastica\Suggest;

use Elastica\Suggest\CandidateGenerator\AbstractCandidateGenerator;
use Elastica\Suggest\CandidateGenerator\DirectGenerator;

/**
 * Class Phrase.
 *
 * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters-phrase.html
 */
class Phrase extends AbstractSuggest
{
    public const DEFAULT_REAL_WORD_ERROR_LIKELIHOOD = 0.95;
    public const DEFAULT_CONFIDENCE = 1.0;
    public const DEFAULT_MAX_ERRORS = 1.0;
    public const DEFAULT_STUPID_BACKOFF_DISCOUNT = 0.4;
    public const DEFAULT_LAPLACE_SMOOTHING_ALPHA = 0.5;

    /**
     * @return $this
     */
    public function setAnalyzer(string $analyzer): Phrase
    {
        return $this->setParam('analyzer', $analyzer);
    }

    /**
     * Set the max size of the n-grams (shingles) in the field.
     *
     * @return $this
     */
    public function setGramSize(int $size): Phrase
    {
        return $this->setParam('gram_size', $size);
    }

    /**
     * Set the likelihood of a term being misspelled even if the term exists in the dictionary.
     *
     * @param float $likelihood Defaults to 0.95, meaning 5% of the words are misspelled.
     *
     * @return $this
     */
    public function setRealWordErrorLikelihood(float $likelihood): Phrase
    {
        return $this->setParam('real_word_error_likelihood', $likelihood);
    }

    /**
     * Set the factor applied to the input phrases score to be used as a threshold for other suggestion candidates.
     * Only candidates which score higher than this threshold will be included in the result.
     *
     * @param float $confidence Defaults to 1.0.
     *
     * @return $this
     */
    public function setConfidence(float $confidence): Phrase
    {
        return $this->setParam('confidence', $confidence);
    }

    /**
     * Set the maximum percentage of the terms considered to be misspellings in order to form a correction.
     *
     * @return $this
     */
    public function setMaxErrors(float $max): Phrase
    {
        return $this->setParam('max_errors', $max);
    }

    /**
     * @return $this
     */
    public function setSeparator(string $separator): Phrase
    {
        return $this->setParam('separator', $separator);
    }

    /**
     * Set suggestion highlighting.
     *
     * @return $this
     */
    public function setHighlight(string $preTag, string $postTag): Phrase
    {
        return $this->setParam('highlight', [
            'pre_tag' => $preTag,
            'post_tag' => $postTag,
        ]);
    }

    /**
     * @return $this
     */
    public function setStupidBackoffSmoothing(float $discount): Phrase
    {
        return $this->setSmoothingModel('stupid_backoff', [
            'discount' => $discount,
        ]);
    }

    /**
     * @return $this
     */
    public function setLaplaceSmoothing(float $alpha): Phrase
    {
        return $this->setSmoothingModel('laplace', [
            'alpha' => $alpha,
        ]);
    }

    /**
     * @return $this
     */
    public function setLinearInterpolationSmoothing(float $trigramLambda, float $bigramLambda, float $unigramLambda): Phrase
    {
        return $this->setSmoothingModel('linear_interpolation', [
            'trigram_lambda' => $trigramLambda,
            'bigram_lambda' => $bigramLambda,
            'unigram_lambda' => $unigramLambda,
        ]);
    }

    /**
     * @param string $model the name of the smoothing model
     *
     * @return $this
     */
    public function setSmoothingModel(string $model, array $params): Phrase
    {
        return $this->setParam('smoothing', [
            $model => $params,
        ]);
    }

    /**
     * @return $this
     */
    public function addDirectGenerator(DirectGenerator $generator): self
    {
        return $this->addParam('candidate_generator', $generator);
    }

    /**
     * @deprecated since version 7.2.0, use the "addDirectGenerator()" method instead.
     *
     * @return $this
     */
    public function addCandidateGenerator(AbstractCandidateGenerator $generator): Phrase
    {
        \trigger_deprecation('ruflin/elastica', '7.2.0', 'The "%s()" method is deprecated, use the "addDirectGenerator()" method instead. It will be removed in 8.0.', __METHOD__);

        return $this->addParam('candidate_generator', $generator);
    }

    /**
     * {@inheritdoc}
     */
    public function toArray(): array
    {
        $array = parent::toArray();

        $baseName = $this->_getBaseName();

        if (isset($array[$baseName]['candidate_generator'])) {
            $generators = $array[$baseName]['candidate_generator'];
            unset($array[$baseName]['candidate_generator']);

            foreach ($generators as $generator) {
                $keys = \array_keys($generator);
                $values = \array_values($generator);

                $array[$baseName][$keys[0]][] = $values[0];
            }
        }

        return $array;
    }
}