Algolia\ScoutExtended\Settings\SettingAttribute\attributeForFaceting

Complexity

Total Complexity

2

Size/Duplication

Total Lines	29
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	getValue()	0	7	2

<?php

declare(strict_types=1);

/**
 * This file is part of Scout Extended.
 *
 * (c) Algolia Team <contact@algolia.com>
 *
 *  For the full copyright and license information, please view the LICENSE
 *  file that was distributed with this source code.
 */

namespace Algolia\ScoutExtended\Settings\SettingAttribute;

use Illuminate\Support\Str;
use Algolia\ScoutExtended\Contracts\SettingContract;

class attributeForFaceting implements SettingContract
{
    /**
     * @var string[]
     */
    private static $attributesForFacetingKeys = [
        '*category*',
        '*list*',
        '*country*',
        '*city*',
        '*type*',
    ];

    /**
     * Checks if the given key/value is a 'attributesForFaceting'.
     *
     * @param  string $key
     * @param  array|null|string $value
     * @param  array $attributesForFaceting
     *
     * @return array
     */
    public function getValue(string $key, $value, array $attributesForFaceting): array
    {
        if (Str::is(self::$attributesForFacetingKeys, $key)) {
            $attributesForFaceting[] = $key;
        }

        return $attributesForFaceting;
    }
}