https://github.com/zingimmick/laravel-query-builder

The easiest way to build Eloquent queries from request
https://github.com/zingimmick/laravel-query-builder

laravel request-query-builer

Last synced: 9 months ago
JSON representation

The easiest way to build Eloquent queries from request

• Host: GitHub
• URL: https://github.com/zingimmick/laravel-query-builder
• Owner: zingimmick
• License: mit
• Created: 2020-04-14T13:47:03.000Z (over 6 years ago)
• Default Branch: 3.x
• Last Pushed: 2024-08-21T19:57:51.000Z (almost 2 years ago)
• Last Synced: 2024-10-30T01:51:23.776Z (over 1 year ago)
• Topics: laravel, request-query-builer
• Language: PHP
• Homepage:
• Size: 512 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Laravel Query Builder

![Code snippet](./docs/snippet.png)

[![Build Status](https://github.com/zingimmick/laravel-query-builder/actions/workflows/tests.yml/badge.svg?branch=3.x)](https://github.com/zingimmick/laravel-query-builder/actions/workflows/tests.yml)

[![Code Coverage](https://codecov.io/gh/zingimmick/laravel-query-builder/branch/3.x/graph/badge.svg)](https://codecov.io/gh/zingimmick/laravel-query-builder)

[![Latest Stable Version](https://poser.pugx.org/zing/laravel-query-builder/v/stable.svg)](https://packagist.org/packages/zing/laravel-query-builder)

[![Total Downloads](https://poser.pugx.org/zing/laravel-query-builder/downloads)](https://packagist.org/packages/zing/laravel-query-builder)

[![Latest Unstable Version](https://poser.pugx.org/zing/laravel-query-builder/v/unstable.svg)](https://packagist.org/packages/zing/laravel-query-builder)

[![License](https://poser.pugx.org/zing/laravel-query-builder/license)](https://packagist.org/packages/zing/laravel-query-builder)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/zingimmick/laravel-query-builder/badges/quality-score.png)](https://scrutinizer-ci.com/g/zingimmick/laravel-query-builder)

[![StyleCI Shield](https://github.styleci.io/repos/255621279/shield?branch=3.x)](https://github.styleci.io/repos/255621279)

[![Code Climate](https://api.codeclimate.com/v1/badges/6bd3cbd5bd75b6ec5b2e/maintainability)](https://codeclimate.com/github/zingimmick/laravel-query-builder/maintainability)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fzingimmick%2Flaravel-query-builder.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fzingimmick%2Flaravel-query-builder?ref=badge_shield)

### Requirements

- [PHP 8.0+](https://php.net/releases/)

- [Composer](https://getcomposer.org)

- [Laravel 8.0+](https://laravel.com/docs/releases)

Require Laravel Query Builder using [Composer](https://getcomposer.org):

```bash

composer require zing/laravel-query-builder

```

- [Basic usage](#basic-usage)

- [Search](#search)

  - [Composite search](#composite-search)

- [Filter](#filter)

  - [Typed filter](#typed-filter)

  - [Flagged filter](#flagged-filter)

  - [Cast Input(Skip auto cast)](#cast-inputskip-auto-cast)

- [Sort](#sort)

- [Paginator](#paginator)

## Usage

### Basic usage

```php

use Zing\QueryBuilder\QueryBuilder;

use Zing\QueryBuilder\Tests\Models\User;

// uri: /api/users?search=Harry&status=1,2,3&desc=created_at&per_page=10

// sql: select * from "users" where ("name" like "%Harry%") and "status" in ("1", "2", "3") order by "created_at" desc limit 11 offset 0

QueryBuilder::fromBuilder(User::class, $request)

    ->searchable(['name'])

    ->enableFilters(['is_visible', 'status'])

    ->enableSorts(['created_at'])

    ->enablePaginator()

    ->simplePaginate();

```

### Search

```php

use Zing\QueryBuilder\QueryBuilder;

use Zing\QueryBuilder\Tests\Models\User;

// uri: /api/users?search=Harry

// sql: select * from "users" where ("name" like "%Harry%" or "email" like "%Harry%") limit 16 offset 0

QueryBuilder::fromBuilder(User::class, $request)

    ->searchable(['name', 'email'])

    ->simplePaginate();

```

#### Composite search

**⚠️ The filter with default value is not supported yet.**

```php

use Zing\QueryBuilder\Filter;

use Zing\QueryBuilder\QueryBuilder;

use Zing\QueryBuilder\Tests\Models\User;

// uri: /api/users?search=2021

// sql: select * from "users" where ("number" like "%2021%" or ("id" = "2021")) limit 16 offset 0

QueryBuilder::fromBuilder(User::class, $request)

    ->searchable(['number', Filter::exact('encoded_id', 'id')])

    ->simplePaginate();

```

### Filter

```php

use Zing\QueryBuilder\Filter;

use Zing\QueryBuilder\QueryBuilder;

use Zing\QueryBuilder\Tests\Models\User;

// uri: /api/users?name=Harry

// sql: select * from "users" where "name" like "%Harry%" limit 16 offset 0

QueryBuilder::fromBuilder(User::class, $request)

    ->enableFilters([Filter::partial('name')])

    ->simplePaginate();

```

```php

use Zing\QueryBuilder\Filter;

use Zing\QueryBuilder\QueryBuilder;

use Zing\QueryBuilder\Tests\Models\User;

// uri: /api/users?status=1,2,3

// sql: select * from "users" where "status" in ("1", "2", "3") limit 16 offset 0

QueryBuilder::fromBuilder(User::class, $request)

    ->enableFilters([Filter::exact('status')])

    ->simplePaginate();

```

```php

use Zing\QueryBuilder\Filter;

use Zing\QueryBuilder\QueryBuilder;

use Zing\QueryBuilder\Tests\Models\User;

// uri: /api/users?visible=1

// sql: select * from "users" where "is_visible" = true limit 16 offset 0

// uri: /api/users

// sql: select * from "users" where "is_visible" = true limit 16 offset 0

QueryBuilder::fromBuilder(User::class, $request)

    ->enableFilters([Filter::scope('visible')->default(true)])

    ->simplePaginate();

```

#### Typed filter

**⚠️ The filter with default value is not supported yet.**

```php

use Zing\QueryBuilder\Filter;

use Zing\QueryBuilder\QueryBuilder;

use Zing\QueryBuilder\Tests\Models\Order;

// uri: /api/users?search_type=number&search_value=2021

// sql: select * from "orders" where "number" like "%2021%" limit 16 offset 0

QueryBuilder::fromBuilder(Order::class, $request)

    ->enableTypedFilter(

        'search_type',

        'search_value',

        [Filter::partial('number'), Filter::partial('user_name', 'user.name')]

    )

    ->simplePaginate();

```

#### Flagged filter

```php

use Zing\QueryBuilder\Filter;

use Zing\QueryBuilder\QueryBuilder;

use Zing\QueryBuilder\Tests\Models\Order;

// uri: /api/users?number=2021&user_name=Jone

// sql: select * from "orders" where (("number" like "%2021%") or (exists (select * from "users" where "orders"."user_id" = "users"."id" and "users"."name" like "%Jone%"))) limit 16 offset 0

QueryBuilder::fromBuilder(Order::class, $request)

    ->enableFlaggedFilter([Filter::partial('number'), Filter::partial('user_name', 'user.name')])

    ->simplePaginate();

```

#### Cast Input(Skip auto cast)

```php

use Zing\QueryBuilder\Enums\CastType;

use Zing\QueryBuilder\Filter;

use Zing\QueryBuilder\QueryBuilder;

use Zing\QueryBuilder\Tests\Models\User;

// uri: /api/users?is_visible=true

// sql: select * from "users" where "is_visible" = true limit 16 offset 0

// uri: /api/users?is_visible=true,false

// sql: select * from "users" where "is_visible" in (true, false) limit 16 offset 0

QueryBuilder::fromBuilder(User::class, $request)

    ->enableFilters(Filter::exact('is_visible')->withCast(CastType::BOOLEAN))

    ->simplePaginate();

```

```php

use Zing\QueryBuilder\Enums\CastType;

use Zing\QueryBuilder\Filter;

use Zing\QueryBuilder\QueryBuilder;

use Zing\QueryBuilder\Tests\Models\Order;

// uri: /api/orders?content=code,and

// sql: select * from "orders" where "content" like "%code,and%" limit 16 offset 0

QueryBuilder::fromBuilder(Order::class, $request)

    ->enableFilters(Filter::partial('content')->withCast(CastType::ORIGINAL))

    ->simplePaginate();

```

### Sort

```php

use Zing\QueryBuilder\QueryBuilder;

use Zing\QueryBuilder\Sort;

use Zing\QueryBuilder\Tests\Models\Order;

// uri: /api/users?desc=created_date

// sql: select * from "orders" order by "created_at" desc limit 16 offset 0

QueryBuilder::fromBuilder(Order::class, $request)

    ->enableSorts([Sort::field('created_date', 'created_at')])

    ->simplePaginate();

```

### Paginator

```php

use Zing\QueryBuilder\QueryBuilder;

use Zing\QueryBuilder\Tests\Models\User;

// uri: /api/users?size=5

// sql: select * from "users" limit 6 offset 0

QueryBuilder::fromBuilder(User::class, $request)

    ->enablePaginator('size')

    ->simplePaginate();

```

```php

use Zing\QueryBuilder\Paginator;

use Zing\QueryBuilder\QueryBuilder;

use Zing\QueryBuilder\Tests\Models\User;

// uri: /api/users?size=

// sql: select * from "users" limit 6 offset 0

QueryBuilder::fromBuilder(User::class, $request)

    ->enablePaginator(Paginator::name('size')->default(5))

    ->simplePaginate();

```

## License

Laravel Query Builder is an open-sourced software licensed under the [MIT license](LICENSE).

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fzingimmick%2Flaravel-query-builder.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fzingimmick%2Flaravel-query-builder?ref=badge_large)