Jidaikobo\Kontiki\Models\BaseModelTraits\SearchTrait

Complexity

Total Complexity

8

Size/Duplication

Total Lines	36
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getSearchableFields()	0	9	4
A	getAdditionalConditions()	0	3	1
A	buildSearchConditions()	0	13	3

<?php

namespace Jidaikobo\Kontiki\Models\BaseModelTraits;

use Illuminate\Database\Query\Builder;

trait SearchTrait
{
    /**
     * Get searchable fields from the model's properties.
     *
     * @return array
     */
    protected function getSearchableFields(): array
    {
        $searchableColumns = [];
        foreach ($this->getFieldDefinitions() as $column => $config) {

It seems like getFieldDefinitions() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            if (isset($config['searchable']) && $config['searchable'] === true) {
                $searchableColumns[] = $column;
            }
        }
        return $searchableColumns;
    }

    protected function getAdditionalConditions(Builder $query, string $context = 'all'): Builder

The parameter $context is not used and could be removed.

    {
        return $query;
    }

    public function buildSearchConditions(Builder $query, string $keyword = ''): Builder
    {
        if (!empty($keyword)) {
            $searchableColumns = $this->getSearchableFields();

            $query->where(function ($q) use ($keyword, $searchableColumns) {
                foreach ($searchableColumns as $column) {
                    $q->orWhere($column, 'LIKE', "%{$keyword}%");
                }
            });
        }

        return $query;
    }
}