Download the PHP package ahmmmmad11/filters without Composer

This package serves as a wrapper over the popular spatie query builder. Its primary purpose is to quickly scaffold filters for your application.

Installation

You can install the package via composer:

After installation, you can publish the configuration file using the following command:

This is the contents of the published config file:

Usage

create your first filter

This will generate a UsersFilter class in the ‘app/Http/Filters’ directory. You can then customize this filter according to your application’s needs.

Certainly! Here’s a rephrased version of your instructions:

If you follow the correct naming convention, you can omit the --model option. For instance, if you have a User model, you can use the following simplified command:

In this case, since you used the plural form of the model (User becomes “Users”), or if you prefer the singular form (UserFilter), the filter command will automatically associate it with the User model.

Please note that this rule does not apply to combined model names like UserProduct. In such cases, please explicitly specify the model using the --model=UserProduct option or the shorter -m"UserProduct" form.

now you can use the filter by injecting UserFilter in your controller like:

or you may want to return paginated data

if you want to assign the size of the pagination form the client side you can do it by leaving the paginate argument empty

if the rows argument of paginate method is left empty and no ?paginate in request query the default row size in filters.php config will be used.

Extend Eloquent methods

you can preform customization over the query directly from you controller method by passing callback to execute method.

inside execute callback function you can use all eloquent methods.

Include relations

to include model relations just add option --relations to filter make command.

or short form

this will generate:

for more details check Spatie Laravel-query-builder

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Ahmed Mohamed
• All Contributors

License

The MIT License (MIT). Please see License File for more information.