Wallogit.com
2017 © Pedro Peláez
Minimal interface for criteria pattern
Minimal implementation of criteria pattern for Laravel., (*1)
Criteria is an implementation of \Baethon\LaravelCriteria\CriteriaInterface which is responsible for only one thing - modify Laravels query in a specified way., (*2)
This allows to decouple and re-use query modifiers., (*3)
Criteria are very similar to Eloquent scopes. The main difference is that they can be applied to different models across the application., (*4)
composer require baethon/laravel-criteria
This library has no dependencies to Laravel itself. It should work with all versions of Laravel., (*5)
First, you need to create an implementation of CriteriaInterface:, (*6)
<?php
use Baethon\LaravelCriteria\CriteriaInterface;
class CompareCriteria implements CriteriaInterface
{
private $field;
private $value;
public function __construct(string $field, string $value)
{
$this->field = $field;
$this->value = $value;
}
public function apply($query)
{
$query->where($this->field, $this->value);
}
}
Now, you can apply it to the query:, (*7)
$query = User::query();
(new CompareCriteria('name', 'Jon'))->apply($query);
$jon = $query->first();
To simplify things it's possible to use AppliesCriteria trait in a model., (*8)
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();
The package provides collections which allow applying multiple criteria at once., (*9)
To apply group of criteria use \Baethon\LaravelCriteria\Collections\CriteriaCollection:, (*10)
$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():, (*11)
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:, (*12)
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');
});
Run tests with:, (*13)
./vendor/bin/phpunit
Please see CHANGELOG for more information what has changed recently., (*14)
The MIT License (MIT). Please see License File for more information., (*15)
Minimal interface for criteria pattern
MIT
Minimal interface for criteria pattern
MIT
Minimal interface for criteria pattern
MIT
Minimal interface for criteria pattern
MIT