Firesphere\SolrSearch\Helpers\Synonyms

Complexity

Total Complexity

5

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	1	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getSynonyms()	0	7	3
A	getSynonymsAsString()	0	8	2

<?php


namespace Firesphere\SolrSearch\Helpers;

use SilverStripe\Core\Config\Configurable;

/**
 * Class Synonyms
 * Source: @link https://raw.githubusercontent.com/heiswayi/spelling-uk-vs-us/
 * @package Firesphere\SolrSearch\Helpers
 */
class Synonyms
{
    use Configurable;

    /**
     * @var array Synonym list
     */
    protected static $synonyms;

    /**
     * Make the UK to US spelling synonyms as a newline separated string
     * Or any other synonyms defined if the user wishes to do so
     * @param bool $defaults add Default UK-US synonyms to the list
     * @return string
     */
    public static function getSynonymsAsString($defaults = true)
    {
        $result = [];
        foreach (static::getSynonyms($defaults) as $synonym) {
            $result[] = implode(',', $synonym);
        }

        return implode(PHP_EOL, $result) . PHP_EOL;
    }

    /**
     * Get the available synonyms as an array from config
     * Defaulting to adding the UK to US spelling differences
     * @param bool $defaults adds the UK to US spelling to the list if true
     * @return array
     */
    public static function getSynonyms($defaults = true)
    {
        // If we want the defaults, load it in to the array, otherwise return an empty array
        $usuk = $defaults ? static::config()->get('usuk')['synonyms'] : [];
        $synonyms = static::config()->get('synonyms') ?: [];

        return array_merge($usuk, $synonyms);
    }
}