laravel.pw

English

Русский

English

Русский

Appearance

Query BuilderEloquent queries from API requests

The filter[], sort, include and fields[] query parameters are checked against an allow-list and applied to an Eloquent query.

Documentation 1.x
GitHub
UserController.php
GET /users?fields[users]=name&fields[posts]=title&include=posts
QueryBuilder::for(User::class)
    ->allowedFields('name', 'posts.title')
    ->allowedIncludes('posts')
    ->get();
select "users"."name", "users"."id" from "users"
select "posts"."title", "posts"."user_id" from "posts"
  where "posts"."user_id" in (1, 2, 3)
   relation keys added automatically

Drop-in replacement for spatie

API-compatible with spatie/laravel-query-builder 7.x, with the same class names, method signatures, exceptions and configuration file. Switching is a namespace change.

Included relations are never empty

When a sparse fieldset is requested together with an include, the keys every included relation needs are added to the SELECT automatically.

Definitions API

Typed filters and operators, relation sorts, virtual fields, nested definitions, pagination, and every request error reported at once.

Installation ​

bash
composer require myprogs/query-builder

Requires PHP 8.3 or newer and Laravel 12 or 13. The service provider is auto-discovered. Continue with the documentation.