Download the PHP package alex-storozhenko/eloquent-criteria without Composer

Eloquent Criteria

⚠️ Compatibility Notes:

Please use 1.x.x version for Laravel 9 compatibility:

This is a lightweight implementation of Criteria Builder for Eloquent. It's like LEGO® for Eloquent Builder, providing easy decoupling and reuse of query modifiers.

Obviously, the main purpose is to modify the query in the specified way, since Criteria are very similar to Eloquent scopes, only with that they can be applied in different way in a app and encapsulate more complex conditions with additional logic in a pretty clean way.

Installation

You can install the package via composer:

You can publish the config file with:

This is the contents of the published config file:

Usage

There are several ways to get started with the Criteria Builder, one of which is to simply enable the macro and make it work globally, just add it to your .env file

Macro

or change a value in config eloquent-criteria.php

and let's do magic:

Criteria class

and apply to query

Concern

Of course, if you are against macros and prefer to control everything, then there is an assistant(concern) for you:

and you ready do it again:

CriteriaModel

you also can just extend your model:

Wrapper through for()

finally, if you need to make Eloquent instantly compatible with Criteria, yes, you can:

CriteriaChain

Of course, you can group your criteria and apply them in a chain, for this please use CriteriaChain, which compile all of passed in Criteria to executable chain of query modifiers:

At first glance, it may seem that all this can be replaced with model scopes that are available out of the box in Laravel, yes, but if you need to have groups of modifiers, and also your modifier will build a query based on several conditions that are defined outside the model, this can be very overloading model classes.

For example, in the following case, I think the Criteria class looks much better than the model scopes with the requirements passing requests and applying conditions of, and if you imagine that this logic possibly can be extended by other conditions:

As you can see, Criteria Builder provides absolute freedom of usage approaches, so it is up to you to decide how best to implement it in your application architecture.

Testing

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please if you found any security issues, write the details to my email: [email protected]

Credits

• Alex Storozhenko
• All Contributors

License

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