Shamaseen\Repository\Utility\Models\Criteriable

Complexity

Total Complexity

20

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setSearchables()	0	4	1
B	scopeFilterByCriteria()	0	22	7
A	scopeSearchByCriteria()	0	26	5
A	setFilterables()	0	4	1
A	scopeOrderByCriteria()	0	7	2
A	getFilterables()	0	7	2
A	getSearchables()	0	7	2

<?php

namespace Shamaseen\Repository\Utility\Models;

use Illuminate\Database\Eloquent\Builder;

trait Criteriable
{
    protected ?array $searchables = null;
    protected ?array $filterable = null;

    public function scopeFilterByCriteria($query, array $criteria): Builder
    {
        foreach ($this->getFilterables() as $method => $columns) {
            // if this is associative then it is a relation
            if (gettype($method) === "string") {
                if (method_exists($this, $method) && array_key_exists($method, $criteria)) {
                    $query->whereHas($method, function ($query) use ($criteria, $columns, $method) {
                        /* @var $query Builder */
                        $query->where(function ($query2) use ($criteria, $columns, $method) {
                            /* @var $query2 Builder */
                            foreach ((array)$columns as $column) {
                                $query2->where($column, $criteria[$method]);
                            }
                        });
                    });
                }
            } elseif (array_key_exists($columns, $criteria)) {
                $query->where($columns, $criteria);
            }
        }

        return $query;
    }

    public function scopeSearchByCriteria($query, array $criteria): Builder
    {
        if (isset($criteria['search'])) {
            $query->where(function ($q) use ($criteria) {
                /**
                 * @var Builder $q
                 */
                foreach ($this->getSearchables() as $method => $columns) {
                    if (method_exists($this, $method)) {
                        $q->orWhereHas($method, function ($query) use ($criteria, $columns) {
                            /* @var $query Builder */
                            $query->where(function ($query2) use ($criteria, $columns) {
                                /* @var $query2 Builder */
                                foreach ((array)$columns as $column) {
                                    $query2->orWhere($column, 'like', '%' . $criteria['search'] . '%');
                                }
                            });
                        });
                    } else {
                        $q->orWhere($columns, 'like', '%' . $criteria['search'] . '%');
                    }
                }
            });
        }

        return $query;
    }

    public function scopeOrderByCriteria($query, array $criteria): Builder
    {
        if (isset($criteria['order'])) {
            $query->orderBy($criteria['order'], $criteria['direction'] ?? 'desc');
        }

        return $query;
    }

    /**
     * By default, all fillables and not hidden are searchables, if you want to override that explicitly set an array of searchables.
     * For a relation this is the syntax [ relationName => [columns in the relation] ]
     * @return array
     */
    public function getSearchables(): array
    {
        if ($this->searchables !== null) {
            return $this->searchables;
        }

        return array_diff($this->getFillable(), $this->getHidden());

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

The method getFillable() does not exist on Shamaseen\Repository\Utility\Models\Criteriable. Did you maybe mean getFilterables()?

    }

    public function setSearchables($searchables): self
    {
        $this->searchables = $searchables;
        return $this;
    }

    /**
     * By default, all fillables and not hidden are filterables, if you want to override that explicitly set an array of searchables.
     * For a relation this is the syntax [ relationName => [columns in the relation] ]
     * @return array
     */
    public function getFilterables(): array
    {
        if ($this->searchables !== null) {
            return $this->searchables;
        }

        return array_diff($this->getFillable(), $this->getHidden());
    }

    public function setFilterables($searchables): self
    {
        $this->searchables = $searchables;
        return $this;
    }
}