arielmejiadev/laravel-query-class

it creates query classes to handle easily requests with multiple filters, sorts and includes.

1.0.1 2021-07-15 06:44 UTC

Requires

• php: ^7.4|^8.0
• illuminate/support: ^8.0

Requires (Dev)

• orchestra/testbench: ^6.0
• phpunit/phpunit: ^9.0

MIT

• Ariel Mejia Dev

• arielmejiadev
• laravel-query-class

README

It generates query classes to handle requests with multiple filters, sorts and includes.

The idea comes as a tip from a LaraconUS 2019 talk from Freek Van der Herten

Installation

You can install the package via composer:

composer require arielmejiadev/laravel-query-class --dev

Stubs & Commands installation

php artisan query-class:install

Usage

php artisan make:query Users/UserQuery --model=User

It would generate a class in app/Http/Queries/Users/UserQuery.php:

You can choose if your query class would extend from Spatie Query Builder (REST API STANDARD) of from an Eloquent query class (for custom cases).

namespace App\Http\Queries\Users;

use App\Models\User;
use Spatie\QueryBuilder\QueryBuilder;

class UserQuery extends QueryBuilder
{
    public function __construct()
    {
        parent::__construct(User::query());

        $this->allowedFilters('updated_at', 'created_at')
            ->allowedSorts('created_at')
            ->allowedIncludes('team');
    }
}

You can chain any Eloquent method or if you choose Spatie Query Builder methods from both tools.

Now you can inject the Query Class in any controller constructor and the Laravel container will resolve it by itself.

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Ariel Mejia Dev
• Freek Van der Herten
• All Contributors

License

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