Algolia\ScoutExtended\Settings\SettingAttribute\SearchableAttribute

Complexity

Total Complexity

5

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	getValue()	0	9	5

<?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;

/*
 * @internal
 */
final class SearchableAttribute implements SettingContract
{
    /**
     * @var string[]
     */
    private static $unsearchableAttributesKeys = [
        'id',
        '*_id',
        'id_*',
        '*ed_at',
        '*_count',
        'count_*',
        'number_*',
        '*_number',
        '*image*',
        '*url*',
        '*link*',
        '*password*',
        '*token*',
        '*hash*',
    ];

    /**
     * @var string[]
     */
    private static $unsearchableAttributesValues = [
        'http://*',
        'https://*',
    ];

    /**
     * Checks if the given key/value is a 'searchableAttributes'.
     *
     * @param  string $key
     * @param  array|null|string $value
     * @param  array $searchableAttributes
     *
     * @return array
     */
    public function getValue(string $key, $value, array $searchableAttributes): array
    {
        if (! is_object($value) && ! is_array($value) &&
            ! Str::is(self::$unsearchableAttributesKeys, $key) &&
            ! Str::is(self::$unsearchableAttributesValues, $value)) {
            $searchableAttributes[] = $key;
        }

        return $searchableAttributes;
    }
}