Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.eloquentfiltering.com/llms.txt

Use this file to discover all available pages before exploring further.

  • Implement IsFilterable interface.
  • Use Filterable trait.
  • Define allowedFilters() method.
use IndexZer0\EloquentFiltering\Contracts\IsFilterable;
use IndexZer0\EloquentFiltering\Filter\Traits\Filterable;
use IndexZer0\EloquentFiltering\Filter\Contracts\AllowedFilterList;
use IndexZer0\EloquentFiltering\Filter\Filterable\Filter;
use IndexZer0\EloquentFiltering\Filter\FilterType;

class Product extends Model implements IsFilterable
{
    use Filterable;

    public function allowedFilters(): AllowedFilterList
    {
        return Filter::only(
            Filter::field('name', [FilterType::EQUAL]),
        );
    }
}