README

This package allows you to quickly create filters and query objects and use them in your laravel scopes.

Installation

You can install the package via composer:

composer require allenjd3/scopify

You can publish the config file with:

php artisan vendor:publish --tag="scopify-config"

This is the contents of the published config file:

return [
    'default-namespace' => 'App\\Filters',
];

Create a new filter with

php artisan make:scopify YourFilter

Then in your model, add the Filterable trait

class User extends Authenticatable
{
    use Filterable;
}

Then you can use your filters like this-

...
public function scopeMyScope($query)
{
    return (new App\Filters\MyFilter)->call($query)
}

Optionally you can also override the scopifyFilters method to add scopes

protected function scopifyFilters()
{
    return [
        'myScope' => MyFilter::class,
    ];
}

You can now use your scope like you normally would- User::myScope()->get()

You can apply multiple filters like this-

User::filters([
    MyFilter::class,
    MyOtherFilter::class,
])->get();

composer test

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

Please see CONTRIBUTING for details.

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

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