README

Laravel Query Kit is a powerful criteria-based query builder toolkit. It's built with SOLID principles and easy to extend.

🧱 Requirements

• PHP ^8.2
• Laravel ^11.0|^12.0

📦 Installation

composer require arielespinoza07/laravel-query-kit

✨ Features

• ✅ Typed criteria: filters, search, pagination, sorting, soft deletes, and dates
• 🎯 Filter groups with operators (=, like, between, in, not in, etc.) and AND/OR logic
• 🔀 Sorts for relationships (belongsTo, hasOne, hasMany, etc.), with dedicated handlers
• ⚡ Central Facade/Service for composing and executing (builder, collection, pagination, resources)
• 🛡️ Input pre-validation (avoids invalid queries before touching the database)
• 🧩 Extensible architecture through interfaces (add your own criteria for filter or sort)

📁 Directory Structure

├── src/
|   ├── Console/
|   |   └── Commands/
|   |       └── stubs/
|   ├── Contracts/
|   ├── Criteria/
|   |   └── Sort/
|   ├── Exceptions/
|   ├── Handlers/
|   ├── Providers/
|   ├── Service/
|   ├── Support/
|   |   └── Facades/
|   └── ValueObjects/
└── tests/

🚀 Quickstart

use App\Models\User;
use LaravelQueryKit\Criteria\WhereFieldCriteria;
use LaravelQueryKit\Criteria\SortCriteria;
use LaravelQueryKit\Support\Facades\QueryKitBuilder;

$query = QueryKitBuilder::for(new User)
    ->withCriteria(
        new WhereFieldCriteria('email', 'like', '%john.doe%'),
        new SortCriteria('created_at', 'desc')->withDefaultSorts()
    );

1. Get the builder

/** @var \Illuminate\Contracts\Database\Query\Builder $builder */
$builder = $query->builder();

1. Get the model

/** @var \Illuminate\Database\Eloquent\Model|null $response */
$response = $query->toModel();

1. Execute and get the response as a collection

/** @var \Illuminate\Support\Collection $response */
$response = $query->toCollection();

1. Execute and get the response paginated

/** @var \Illuminate\Pagination\LengthAwarePaginator $response */
$response = $query->withPagination(page: 1, perPage: 10)
    ->toPaginated();

1. Execute and get the response as a resource (single model)

use App\Http\Resources\UserResource;

/** @var \Illuminate\Http\Resources\JsonResource $response */
$response = $query->toJsonResource(UserResource::class);

1. Execute and get the response as a resource (collection)

use App\Http\Resources\UserCollection;

/** @var \Illuminate\Http\Resources\Json\ResourceCollection $response */
$response = $query->toResourceCollection(UserCollection::class);

1. Execute and get the response as a resource (collection paginated)

use App\Http\Resources\UserCollection;

/** @var \Illuminate\Http\Resources\Json\ResourceCollection $response */
$response = $query->withPagination(page: 1, perPage: 10)
    ->toResourceCollection(UserCollection::class);

🔎 Methods & Handlers

Artisan Generators

1. Create a new criteria class WeekOrdersCriteria

php artisan make:criteria WeekOrders

<?php

declare(strict_types=1);

namespace App\Criteria\Billing;

use Illuminate\Contracts\Database\Query\Builder;
use Illuminate\Support\Carbon;
use LaravelQueryKit\Contracts\CriteriaInterface;

final readonly class WeekOrdersCriteria implements CriteriaInterface
{
    private Carbon $date;

    public function __construct(
        private string $column = 'created_at',
        private string $boolean = 'and',
        ?string $date = null,
    ) {
        $this->date = isset($date) ? Carbon::parse($date) : now();
    }

    public function apply(Builder $builder): Builder
    {
        $weekDays = [
            $this->date->startOfWeek()->format('Y-m-d H:i:s'),
            $this->date->endOfWeek()->format('Y-m-d H:i:s'),
        ];

        return $builder->whereBetween(
            column: $this->column,
            values: $weekDays,
            boolean: $this->boolean,
        );
    }
}

1. Create a new custom sort criteria, using a relationship MonthBillingOrderByCriteria

php artisan make:criteria Sort/MonthBilling -s

<?php

declare(strict_types=1);

namespace App\Criteria\Sort;

use Illuminate\Contracts\Database\Query\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\Relation;
use LaravelQueryKit\Contracts\SortCriteriaInterface;

final readonly class MonthBillingOrderByCriteria implements SortCriteriaInterface
{
    public function __construct() {}

    /**
     * {@inheritDoc}
     */
    public function apply(Builder $builder, Model $model, Relation $relation, string $column, string $direction): Builder
    {
        // TODO: Implement apply() method.
        return $builder;
    }

    /**
     * {@inheritDoc}
     */
    public function supports(Relation $relation): bool
    {
        // TODO: Implement supports() method.
        return true;
    }
}

🧪 Testing

composer test

🤝 Contributing

See CONTRIBUTING for details.

Changelog

See CHANGELOG for details.

Security

Report vulnerabilities by email or private issues.

📜 License

MIT License