PHPackages                             trocho/laravel-eloquent-filter - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. trocho/laravel-eloquent-filter

ActiveLibrary[Database & ORM](/categories/database)

trocho/laravel-eloquent-filter
==============================

Allows filtering Eloquent queries by input filters

v0.1.1(9y ago)2411MITPHP

Since Jun 12Pushed 9y ago2 watchersCompare

[ Source](https://github.com/Trocho/laravel-eloquent-filter)[ Packagist](https://packagist.org/packages/trocho/laravel-eloquent-filter)[ RSS](/packages/trocho-laravel-eloquent-filter/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependencies (3)Versions (5)Used By (0)

Laravel Eloquent Filter
=======================

[](#laravel-eloquent-filter)

This module lets you filter Eloquent data using query filters. You can apply WHERE filters and also set order of results

Installation
------------

[](#installation)

1. Run

    ```
    composer require mnabialek/laravel-eloquent-filter
    ```

    in console to install this module
2. That's it! Installation is complete. You don't need to adjust any config or install service providers.

Getting started
---------------

[](#getting-started)

Let's assume you want to allow to filter users data. By default you use `User` Eloquent model to get users. To enable filtering, open User model (by default `app/User.php` file) and add into it the following trait:

```
use Mnabialek\LaravelEloquentFilter\Traits\Filterable;
```

just bellow opening class definition, so it should look something like this:

```
class User extends Authenticatable
{
    use Mnabialek\LaravelEloquentFilter\Traits\Filterable;
```

To allow filtering for this class, you need to also create implementation of `Mnabialek\LaravelEloquentFilter\Contracts\QueryFilter` interface. To do that create min `app/Filters` directory file with the following content:

```