Фильтры служат для упрощения поиска записей с использованием типичного фильтра. Например, если вы хотите отфильтровать каталог продуктов по атрибутам, брендам и т.п. Выборка значений основана на параметрах Http запросов.

Это не является готовым решением или универсальным средством, вы должны расширить структуру для своих конкретных приложений.

Автоматическая HTTP фильтрация и сортировка

Для реагирования на HTTP параметры, модель должна включать в себя Filterable, а так же определение доступных атрибутов:

namespace App;

use Illuminate\Database\Eloquent\Model;
use Orchid\Filter\Filterable;

class Post extends Model
{
    use Filterable;

    /**
     * @var array
     */
    protected $allowedFilters = [
        'id',
        'user_id',
        'type',
        'status',
        'content',
        'options',
        'slug',
        'publish_at',
        'created_at',
        'deleted_at',
    ];

    /**
     * @var array
     */
    protected $allowedSorts = [
        'id',
        'user_id',
        'type',
        'status',
        'slug',
        'publish_at',
        'created_at',
        'deleted_at',
    ];
}

Использование заключается в вызове метода filters:

Post::filters()->defaultSort('id')->paginate();

Примечание. Автоматические HTTP фильтры не будут работать с отношениями. Если вас это интересует, вы можете использовать классический фильтр, описанный ниже.

Как будет реагировать фильтрация:

http://example.com/demo?filter[id]=1
$model->where('id', '=', 1)

http://example.com/demo?filter[name]=A
$model->where('name', 'like', '%A%')


http://example.com/demo?filter[id]=1,2,3,4,5
$model->whereIn('id', [1,2,3,4,5]);

http://example.com/demo?filter[id][min]=1&filter[id][max]=5
$model->whereBetween('id', [1,5]);

http://example.com/demo?filter[id][]=1&filter[id][]=2&filter[id][]=3
$model->whereIn('id', [1,2,3]);


http://example.com/demo?filter[content.ru.name]=dwqdwq
$model->where('content->ru->name', 'like', 'dwqdwq');

Примечание. Фильтр соответствует модели cast . Он работает с типами bool,datetime и string (и их псевдонимами). Чтобы использовать в фильтре число в качестве подстроки (используя like вместо точного совпадения), убедитесь, что оно приведено к string.

Как будет реагировать сортировка:

http://example.com/demo?sort=content.ru.name
$model->orderBy('content->ru->name', 'asc');

http://example.com/demo?sort=-content.ru.name
$model->orderBy('content->ru->name', 'desc');

Отличным способом будет использовать такую сортировку в таблицах. Для того чтобы заголовки колонки стали активными, используйте:

use Orchid\Screen\TD;

TD::make('name')->sort();

Классический фильтр

Для создания более сложных запросов, вы можете использовать фильтры Eloquent, которые позволяют вам полностью управлять собой. Существует команда для создания нового фильтра:

php artisan orchid:filter QueryFilter

Это создаст класс фильтра в папке app/Http/Filters.

Пример фильтра:

namespace App\Http\Filters;

use Orchid\Filters\Filter;
use Illuminate\Database\Eloquent\Builder;

class QueryFilter extends Filter
{

    /**
     * @var array
     */
    public $parameters = ['query'];

    /**
     * @param Builder $builder
     *
     * @return Builder
     */
    public function run(Builder $builder): Builder
    {
        return $builder->where('demo', $this->request->get('query'));
    }

    /**
     * @return Field[]
     */
    public function display() : array
    {
        return [
            Input::make('email')
                ->type('text')
                ->value($this->request->get('email'))
                ->placeholder('Search...')
                ->title('Search')
        ];
    }
}

Фильтр сработает при наличии хотя бы одного параметра, указанного в массиве $parameters. Если массив будет пуст, то фильтр будет работать при каждом запросе.

Примечание. Вы можете использовать одни и те же фильтры для разных моделей.

Для использования фильтров в собственных моделях, требуется подключить трейт Orchid\Filter\Filterable и передавать в функцию filtersApply массив классов:

use App\Model;

Model::filtersApply([Filter::class])->simplePaginate();

Selection

Когда вам нужно отобразить фильтры и применить их к модели, их удобнее сгруппировать, создав отдельный слой «Selection». Для создания новогоо слоя выполните команду:

php artisan orchid:selection MySelection

В этом классе есть один-единственный метод, в котором необходимо перечислить все фильтры, которые должны отображаться и применяться, например:

namespace App\Orchid\Layouts;

use Orchid\Platform\Filters\Filter;
use Orchid\Press\Http\Filters\CreatedFilter;
use Orchid\Press\Http\Filters\SearchFilter;
use Orchid\Screen\Layouts\Selection;

class MySelection extends Selection
{
    /**
     * @return Filter[]
     */
    public function filters(): array
    {
        return [
          SearchFilter::class,
          CreatedFilter::class
        ];
    }
}

После этого мы можем применить его к модели:

Model::filtersApplySelection(MySelection::class)->simplePaginate();

Поскольку это слой, его также можно использовать для отображения полей на экране:

use Orchid\Support\Facades\Layout;

public function layout(): array
{
    return [
        MySelection::class,
    ];
}