drupol\phpngrams\NGramsTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	45
Duplicated Lines	0 %

Coupling/Cohesion

Dependencies

1

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	setNgram()	0	4	1
A	getNGrams()	0	4	1
A	frequency()	0	4	1
A	ngrams()	0	4	1

<?php

declare(strict_types = 1);

namespace drupol\phpngrams;

/**
 * Trait NGramsTrait
 */
trait NGramsTrait
{
    /**
     * @var \drupol\phpngrams\NGramsInterface
     */
    private $ngrams;

    /**
     * @param \drupol\phpngrams\NGramsInterface $ngrams
     */
    public function setNgram(NGramsInterface $ngrams)
    {
        $this->ngrams = $ngrams;
    }

    /**
     * @return \drupol\phpngrams\NGramsInterface
     */
    public function getNGrams(): NGramsInterface
    {
        return $this->ngrams;
    }

    /**
     * @param \Generator $ngrams
     * @param string|array $substring
     *
     * @return float|int
     */
    public function frequency(\Generator $ngrams, $substring)
    {
        return $this->getNGrams()->frequency($ngrams, $substring);

It seems like $substring defined by parameter $substring on line 39 can also be of type string; however, drupol\phpngrams\NGramsInterface::frequency() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * @param string|array $data
     * @param int $n
     *
     * @return bool|\Generator
     */
    public function ngrams($data, int $n = 1)
    {
        return $this->getNGrams()->ngrams($data, $n);

It seems like $data defined by parameter $data on line 50 can also be of type string; however, drupol\phpngrams\NGramsInterface::ngrams() does only seem to accept array, maybe add an additional type check?

    }
}