https://github.com/baethon/laravel-criteria
Minimal interface for criteria pattern
https://github.com/baethon/laravel-criteria
Last synced: 25 days ago
JSON representation
Minimal interface for criteria pattern
- Host: GitHub
- URL: https://github.com/baethon/laravel-criteria
- Owner: baethon
- License: mit
- Created: 2018-06-28T14:47:39.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-31T18:02:08.000Z (over 2 years ago)
- Last Synced: 2024-03-15T09:20:12.703Z (about 1 year ago)
- Language: PHP
- Size: 43 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# baethon/laravel-criteria
Minimal implementation of [criteria pattern](https://www.tutorialspoint.com/design_pattern/filter_pattern.htm) for Laravel.
## What is criteria?
Criteria is an implementation of `\Baethon\LaravelCriteria\CriteriaInterface` which is responsible for only one thing - modify Laravels query in a specified way.
This allows to decouple and re-use query modifiers.
Criteria are very similar to [Eloquent scopes](https://laravel.com/docs/eloquent#query-scopes). The main difference is that they can be applied to different models across the application.
## Installation
```php
composer require baethon/laravel-criteria
```
## Requirements
* PHP >= 7.1
### Laravel compatibility
This library has no dependencies to Laravel itself. It should work with all versions of Laravel.
## Usage
First, you need to create an implementation of `CriteriaInterface`:
```php
field = $field;
$this->value = $value;
}
public function apply($query)
{
$query->where($this->field, $this->value);
}
}
```
Now, you can *apply* it to the query:
```php
$query = User::query();
(new CompareCriteria('name', 'Jon'))->apply($query);
$jon = $query->first();
```
### AppliesCriteria trait
To simplify things it's possible to use `AppliesCriteria` trait in a model.
```php
use Baethon\LaravelCriteria\Traits\AppliesCriteria;
class User extends Model
{
// model body stripped for better readability
use AppliesCriteria;
}
$jon = User::query()
->apply(new CompareCriteria('name', 'Jon'))
->first();
```
### Collections
The package provides collections which allow applying multiple criteria at once.
To apply group of criteria use `\Baethon\LaravelCriteria\Collections\CriteriaCollection`:
```php
$jonSnow = User::query()
->apply(CriteriaCollection::create([
new CompareCriteria('name', 'Jon'),
new CompareCriteria('lastname', 'Snow'),
]))
->first();
// same result, without CriteriaCollection
$jonSnow = User::query()
->apply(new CompareCriteria('name', 'Jon'))
->apply(new CompareCriteria('lastname', 'Snow'))
->first();
```
If you need to be sure that all criteria will be fulfilled you can use `CriteriaCollection::allOf()`:
```php
User::query()
->apply(CriteriaCollection::allOf([
new CompareCriteria('name', 'Jon'),
new CompareCriteria('lastname', 'Snow'),
]));
// same as
User::query()
->where(function ($query) {
$query->apply(new CompareCriteria('name', 'Jon'))
->apply(new CompareCriteria('lastname', 'Snow'));
});
```
Also, you can group criteria using logical `OR` join:
```php
User::query()
->apply(CriteriaCollection::oneOf([
new CompareCriteria('name', 'Jon'),
new CompareCriteria('lastname', 'Snow'),
]));
// same as
User::query()
->where(function ($query) {
$query->where('name', 'Jon')
->orWhere('lastname', 'Snow');
});
```
## Testing
Run tests with:
```bash
./vendor/bin/phpunit
```
## Changelog
Please see [CHANGELOG](https://github.com/baethon/laravel-criteria/blob/master/CHANGELOG.md) for more information what has changed recently.
## License
The MIT License (MIT). Please see License File for more information.