Sofa\Eloquence\Searchable\Parser

Complexity

Total Complexity

11

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	parseWeights()	0	8	2
A	addMissingWeights()	0	14	3
A	stripWildcards()	0	4	1
A	parseQuery()	0	10	2
A	splitString()	0	6	1
A	addWildcards()	0	8	1

<?php

namespace Sofa\Eloquence\Searchable;

use Sofa\Eloquence\Contracts\Searchable\Parser as ParserContract;

class Parser implements ParserContract
{
    /**
     * Default search weight.
     *
     * @var int
     */
    protected $weight;

    /**
     * Wildcard token.
     *
     * @var string
     */
    protected $wildcard;

    /**
     * Create new parser instance.
     *
     * @param int $weight
     */
    public function __construct($weight = 1, $wildcard = '*')
    {
        $this->weight = $weight;
        $this->wildcard = $wildcard;
    }

    /**
     * Parse searchable columns.
     *
     * @param  array|string $columns
     * @return array
     */
    public function parseWeights($columns)
    {
        if (is_string($columns)) {
            $columns = func_get_args();
        }

        return $this->addMissingWeights($columns);
    }

    /**
     * Add search weight to the columns if missing.
     *
     * @param array $columns
     */
    protected function addMissingWeights(array $columns)
    {
        $parsed = [];

        foreach ($columns as $column => $weight) {
            if (is_numeric($column)) {
                list($column, $weight) = [$weight, $this->weight];
            }

            $parsed[$column] = $weight;
        }

        return $parsed;
    }

    /**
     * Strip wildcard tokens from the word.
     *
     * @param  string $word
     * @return string
     */
    public function stripWildcards($word)
    {
        return str_replace($this->wildcard, '%', trim($word, $this->wildcard));
    }

    /**
     * Parse query string into separate words with wildcards if applicable.
     *
     * @param  string  $query
     * @param  bool $fulltext
     * @return array
     */
    public function parseQuery($query, $fulltext = true)
    {
        $words = $this->splitString($query);

The expression $this->splitString($query); of type string[]|false adds false to the return on line 95 which is incompatible with the return type declared by the interface Sofa\Eloquence\Contracts\Searchable\Parser::parseQuery of type array. It seems like you forgot to handle an error condition.

        if ($fulltext) {
            $words = $this->addWildcards($words);

It seems like $words can also be of type false; however, Sofa\Eloquence\Searchable\Parser::addWildcards() does only seem to accept array, did you maybe forget to handle an error condition?

        }

        return $words;
    }

    /**
     * Split query string into words/phrases to be searched.
     *
     * @param  string $query
     * @return array
     */
    protected function splitString($query)
    {
        preg_match_all('/(?<=")[\w ][^"]+(?=")|(?<=\s|^)[^\s"]+(?=\s|$)/u', $query, $matches);

        return reset($matches);
    }

    /**
     * Add wildcard tokens to the words.
     *
     * @param array $words
     */
    protected function addWildcards(array $words)
    {
        $token = $this->wildcard;

        return array_map(function ($word) use ($token) {
            return preg_replace('/\*+/', '*', "{$token}{$word}{$token}");
        }, $words);
    }
}