PHPackages marwanmg/eloquent-filter-custom - 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. [API Development](/categories/api) 4. / 5. marwanmg/eloquent-filter-custom ActiveLibrary[API Development](/categories/api) marwanmg/eloquent-filter-custom =============================== A simple Eloquent filter to make easy API filtering, with capability for searching with or operator 09PHP Since Apr 21Pushed 2y agoCompare [ Source](https://github.com/ElzadCompany/eloquent-filter-custom)[ Packagist](https://packagist.org/packages/marwanmg/eloquent-filter-custom)[ RSS](/packages/marwanmg-eloquent-filter-custom/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependenciesVersions (1)Used By (0) Look at the end of file to see forked updates ============================================= [](#look-at-the-end-of-file-to-see-forked-updates) Laravel Legends Eloquent Filter =============================== [](#laravel-legends-eloquent-filter) A useful library to make filters for Eloquent. This library is useful to create search filters in your Rest API using the Eloquent. ๐Ÿ‡ง๐Ÿ‡ท๐Ÿš€๐Ÿš€๐Ÿš€ Description ----------- [](#description) The Eloquent Filter library can be used to create patterns for search criterias on models in your Laravel Project. The idea is aggregate filters simply passing the values in your request payload. Instalation ----------- [](#instalation) For instalation, you should be use Composer. Run the follow command: `composer require marwanmg/eloquent-filter-custom` Usage guide ----------- [](#usage-guide) The `LaravelLegends\EloquentFilter\Concerns\HasFilter` trait can be used in models that will be apply the search filters. ``` use LaravelLegends\EloquentFilter\Concerns\HasFilter; class User extends Model { use HasFilter; } ``` The `HasFilter` trait provides the `filter` and `withFilter` methods. A simple way to use this library in your Laravel application is calling the `filter` method before get results of your model. Example: ``` class UsersController extends Controller { use App\Models\User; public function index() { return User::filter()->paginate(); } // or public function index() { return User::latest('id')->filter()->paginate(); } // or public function index(Request $request) { return User::filter($request)->paginate(); } } ``` You can show the results when call `/api/users?exact[id]=1`. The sql query `"select * from users where (id = 1)"` will be applied. Note: Show the [rules](#max) session to more information. Another way, is using the specific filter for a model. You can inherit the ModelFilter class to create a custom filter for a model. For create this class, you should be use the command `php artisan make:filter`, as follow example: ``` $ php artisan make:filter UserFilter ``` The above command will be generate the follow class: ``` namespace App\Filters; use LaravelLegends\EloquentFilter\Filters\ModelFilter; class UserFilter extends ModelFilter { public function getFilterables(): array { return [ 'role_id' => 'not_equal', // or ['not_equal'] 'name' => ['contains', 'starts_with'], ]; } } ``` In Controller ``` use App\Models\User; use Illuminate\Http\Request; use LaravelLegends\EloquentFilter\Filter; class UsersController extends Controller { // api/users?starts_with[name]=Wallace¬_equal[role_id]=2 public function index(Request $request) { return User::withFilter(new UserFilter, $request) ->orderBy('name') ->get(); } } ``` The above code internally will be called as follow example: ``` User::where(function ($query) { $query->where('name', 'LIKE', 'Wallace%'); $query->where('role_id', '', '2'); }) ->orderBy('name') ->get(); ``` --- What does it do? ---------------- [](#what-does-it-do) This library internally apply filters based on query string parameters with special keyworks names. See all paramaters follow: max --- [](#max) The maximum value of a column. The url `api/users?max[field]=100` is like a `User::where('field', '=', 33)`. --- contains -------- [](#contains) A search term contained in a column. The url `api/users?contains[name]=wallace` is like a `User::where('name', 'LIKE', '%wallace%')`. --- ends\_with ---------- [](#ends_with) Search a value according to end content of string. Is similar to a `LIKE` with `%$value` value. --- starts\_with ------------ [](#starts_with) Filter the field when the value starts with a certain value. A url `api/users?starts_with[name]=brcontainer` Sounds like a `User::where('name', 'LIKE', 'brcontainer%')`. --- exact ----- [](#exact) Search by a exact value of the fieldยท A url `api/users?exact[email]=teste@teste.com` Sounds like a `User::where('name', '=', 'teste@teste.com')`. --- has --- [](#has) Filter by relationship. You can use the `0` or `1` value. Example: The url `api/users?has[posts]=1` is like a `User::has('posts')` The url `api/users?has[posts]=0` is like a `User::doesntHave('posts')` --- is\_null -------- [](#is_null) Apply `WHERE IS NULL` or `WHERE IS NOT NULL` to a query. Example: The url `api/users?is_null[cpf]=1` is like a `User::whereNull('cpf')` The url `api/users?is_null[age]=0` is like a `User::whereNotNull('age')` --- not\_in ------- [](#not_in) Searchs when a column NOT HAS the passed values. Example: A url `api/users?not_in[role][]=1¬_in[role][]=2` รฉ equivalente ร  `User::whereNotIn('role', [1, 2])` **Note**: When the `not_in[my_field]` is a empty array, no action will be taken. --- in -- [](#in) Searchs when a column HAS the passed values. Example: The url `api/users?in[role][]=10&in[role][]=20` sounds like a `User::whereIn('role', [10, 20])` **NOTE**: When the `in[my_field]` is a empty array, no action will be taken. --- date\_max --------- [](#date_max) Search by a maximium value of a date field. A url `api/users?date_max[created_at]=2021-01-01` sounds like a `User::whereDate('created_at', '=', '2021-01-01')` --- not\_equal ---------- [](#not_equal) Search by not equal value passed. If you use in related field, the whereDoesntHave will be applied applied. Example: The url `api/users?not_equal[profile_id]=3` sounds like a ``` User::where('profile_id', '', '3'); ``` The url `api/users?not_equal[roles.id]=1` sounds like a ``` User::whereDoesntHave('roles', fn ($query) => $query->where('id', '=', 3)); ``` --- year\_max --------- [](#year_max) The url `api/users?year_max[created_at]=2000` sounds like a ``` User::whereYear('created_at', '=', 1998); ``` --- year\_exact ----------- [](#year_exact) The url `api/users?year_exact[created_at]=1998` sounds like a ``` User::whereYear('created_at', '=', 1998); ``` --- Filtering relationship fields ----------------------------- [](#filtering-relationship-fields) You can apply the search filters in the relatioship methods defined in your model. For example: Model: ``` class User extends Model { use HasFilter; public function phones() { return $this->hasMany(Phone::class, 'user_id'); } } ``` Filters: ``` class UserFilter extends ModelFilter { public function getFilterables(): array { return [ 'id' => ['exact', 'not_equal'], 'created_at' => ['year_exact', 'date_max', 'date_min'], 'phones.number' => ['contains'], // or 'phones' => new PhoneFilter, ]; } } class PhoneFilter extends ModelFilter { public function getFilterables(): array { return [ 'number' => 'contains' ]; } } ``` ``` class UserController extends Controller { public function index() { // api/users?not_in[role_id][]=1¬_in[role_id][]=3 // select * from users where (role_id NOT IN (1, 3)) return User::withFilter(new UserFilter)->paginate(); } // Or, apply filter as nested query public function index() { // api/users?exact[role_id]=1 // select * from users where (role_id = 1) return User::where(UserFilter::toClosure())->paginate(); } // Or apply in your query as base condition public function index() { // api/users?exact[role_id]=1 // select * from users where role_id = 1 return User::tap(UserFilter::toClosure())->paginate(); } } ``` In the following example, the user will be filtered for the related phone containing the value `55`. The `api/users?exact[phones.number]=55` is like to: ``` User::where(function ($query) { $query->whereHas('phones', function ($query) { $query->where('number', '=', '55'); }); })->paginate(); ``` Axios examples -------------- [](#axios-examples) If you use `axios` library, you can use the `params` options to include the above filters. Example: ``` const api = axios.create({ baseURL: 'http://localhost:8000/api' }); api.get('users', { params: { 'in[role]' : [1, 2, 3], 'contains[name]' : 'Maxters', 'is_null[name]' : 0 } }) ``` Forked Version Update ===================== [](#forked-version-update) Here are the new updates in this forjed version contains or ----------- [](#contains-or) The url `api/users?contains[name,name_en]=tomato` sounds like a ``` User::where('name', 'LIKE', '%value%')->orWhere('name_en', 'LIKE', '%value%'); ``` and can add more colums url `api/users?contains[name,name_en,name_fr]=tomato` sounds like a ``` User::where('name', 'LIKE', '%value%')->orWhere('name_en', 'LIKE', '%value%')->orWhere('name_fr', 'LIKE', '%value%'); ``` --- ### Health Score 13 โ€” LowBetter than 1% of packages Maintenance20 Infrequent updates โ€” may be unmaintained Popularity4 Limited adoption so far Community8 Small or concentrated contributor base Maturity19 Early-stage or recently created project Bus Factor1 Top contributor holds 96.1% of commits โ€” single point of failure How is this calculated?**Maintenance (25%)** โ€” Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** โ€” Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** โ€” Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** โ€” Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/0cb9c14d92a1a132708ac87c87fc87b0b22cfa44888dda777eb372192cdd2373?d=identicon)[Marwan1998](/maintainers/Marwan1998) --- Top Contributors [![wallacemaxters](https://avatars.githubusercontent.com/u/5245865?v=4)](https://github.com/wallacemaxters "wallacemaxters (99 commits)")[![Marwan1998](https://avatars.githubusercontent.com/u/31594156?v=4)](https://github.com/Marwan1998 "Marwan1998 (4 commits)") ### Embed Badge ![Health badge](/badges/marwanmg-eloquent-filter-custom/health.svg) ``` [![Health](https://phpackages.com/badges/marwanmg-eloquent-filter-custom/health.svg)](https://phpackages.com/packages/marwanmg-eloquent-filter-custom) ``` ### Alternatives [stripe/stripe-php Stripe PHP Library 4.0k143.3M475](/packages/stripe-stripe-php)[twilio/sdk A PHP wrapper for Twilio's API 1.6k92.9M270](/packages/twilio-sdk)[knplabs/github-api GitHub API v3 client 2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk PHP SDK for Facebook Business 90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php PHP wrapper for the Meilisearch API 73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax Google API Core for PHP 263103.1M453](/packages/google-gax) PHPackages ยฉ 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)