PHPackages                             drewlabs/laravel-query - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. drewlabs/laravel-query

ActiveLibrary[Database & ORM](/categories/database)

drewlabs/laravel-query
======================

Provides drewlabs/query bindings for laravel framework

v0.3.30(10mo ago)04101MITPHPPHP ^8.0

Since May 28Pushed 10mo ago1 watchersCompare

[ Source](https://github.com/azlabsphp/laravel-query)[ Packagist](https://packagist.org/packages/drewlabs/laravel-query)[ RSS](/packages/drewlabs-laravel-query/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (9)Versions (50)Used By (1)

Laravel Query Bindings
======================

[](#laravel-query-bindings)

The laravel query package provides `drewlabs/query` library bindings for laravel based projects. It uses `Laravel` eloquent API for database queries.

Usage
-----

[](#usage)

### Providers

[](#providers)

- Laravel When using Laravel framework the service provider is automatically registered.
- Lumen For Lumen appliation you must manually register the providers in the bootstrap/app.php:

```
// bootstrap/app.php
// ...
$app->register(\Drewlabs\Laravel\Query\ServiceProvider::class);
// ...
```

### Components

[](#components)

#### The Query Language

[](#the-query-language)

This component offer a unified language for quering the database using SELECT, CREATE, UPDATE and DELETE methods. It heavily makes use of PHP dictionnary a.k.a arrays for various operations.

##### Creating instance of the DMLManager

[](#creating-instance-of-the-dmlmanager)

```
// ...
use function Drewlabs\Laravel\Query\Proxy\DMLManager;

// Example class
use App\Models\Example;

// Create a query manager for querying database using Example model
$ql = DMLManager(Example::class);
```

##### `Create` API

[](#create-api)

The method takes in the attributes to insert into the database table as a row.

```
// Insert single values to the database
$example = DMLManager(Example::class)->create([/* ... */]);
```

Note: In it complex form, the create method takes in the attributes to insert and a set of parameters:

```
$person = DMLManager(Example::class)->create([
        /* ... */
        'addresses' => [ [/* ... */] ],
        'profile' => [/* ... */]
    ],[
        // Here we tells the query provider to use `profile`, `addresses` keys of `inputs` as relation
        // methods of the model class
        'relations' => ['addresses', 'profile']
    ]);
```

The create method also takes in a 3rd parameter `PHP Closure` that can be executed after the create operation

Examples:

```
// Insert single values to the database
$example = DMLManager(Example::class)->create([/* ... */], function($value) {
    // Do something with the created value
});
```

##### `Update` API

[](#update-api)

As the `create` method, the `update` method also provides overloaded method implementations for interacting with the database.

```
$person = DMLManager(Example::class)->update(1, ['firstname' => '...']);

// Update by ID String
$person = DMLManager(Example::class)->update("1", ['firstname' => '...']);

// Update using query without mass update
$count = DMLManager(Example::class)->update(['and' => ['name', '...']], ['firstname' => '...']);
```

##### `Delete` API

[](#delete-api)

Delete provides an interface for deleting items based on there id or a complex query.

```
// DELETE AN ITEM BY ID
$result = DMLManager(Example::class)->delete(1);

// DELET AN ITEM USING QUERY FILTERS
$result = DMLManager(Example::class)->delete(['and' => ['...', '...']], true);
```

##### `Select` API

[](#select-api)

`select` method of the DMLManger, provides a single method for querying rows in the database using either query filters.

```
$person = DMLManager(Person::class)->select("1", ['*'], function ($model) {
    return $model->toArray();
});

// Select by ID
$person = DMLManager(Person::class)->select(1);

$list = DMLManager(Person::class)->select([/* ... */],['firstname', 'addresses']);

// Select using query filters
$list = DMLManager(Person::class)->select([/* ... */], 15, ['addresses', 'profile'], 1);
```

#### Query filters

[](#query-filters)

Filters provides a uniform interface to perform database queries.

- `CreateQueryFilters` API

`CreateQueryFilters` is a factory function which when called create a filters binding for laravel database library.

```
use Drewlabs\Laravel\Query\Proxy\CreateQueryFilters;

/// Note: Each key is an eloquent model/Eloquent query builder method
/// Parameters are passed in the order and the same way they are passed to the model method, but are specified as array
$filter = CreateQueryFilters([
    // Creatigng a where query
    'where' => [
        ['label', ''],
        ['slug', 'like', '']
    ],
    'orWhere' => ['id' , '', ''],
    'whereHas' => ['relation_name', function($query){
        // ... Provide the subquery
    }],
    // Multiple subqueries at once
    'whereDoesntHave' => [
        ['relation1', function($query){
        // ... Provide the subquery
        }],
        ['relation1', function($query){
        // ... Provide the subquery
        }]
    ],
    // Query date field
    'whereDate' => [$date],

    // Query relation presence
    'has' => 'hasRelation',

    // Query presence of multiple relations
    'has' => ['relation1', 'relation2'],

    // Where in query
    'whereIn' => ['column', [...]],

    // Multiple WherNotIn query

    'whereNotIn' => [
        ['colum1', [...]],
        ['colum2', [...]]
    ],

    // Join query
    'join' => [
        Folder::class,
        ['model' => UploadedFile::class, 'column' => 'folder_id'],
        ['model' => Folder::class, 'column' => 'id']
    ],
    // Normal laravel join
    'join' => ['table1', 'table2.id', '=', 'table1.user_id']
]);

// Calling the query filter on laravel database builder instance
$result = $filter->call(TestModel::query())->get($columns = ['*']);
```

#### The query filters API

[](#the-query-filters-api)

The query filters API provides a list of filters that can be used to perform database query using PHP key-value pair array (a.k.a dictionnary) to send query using the framework database API.

### Example

[](#example)

```
// imports
// ...

// Create the request
$request = new \Illuminate\Http\Request([
    '_query' => [
        'where' => ['label', '', 'Hello World!'],
        'orWhere' => [
            [
                'match' => [
                    'method' => 'whereIn',
                    'params' => ['url', [/* ... */]]
                ]
            ],
            [
                'id', 340
            ]
        ],
        'whereNull' => [
            'column' => 'basepath'
        ],
        'whereIn' => [
            [
                "column" => 'basepath',
                "match" => ['/home/usr/workspace', '/local/usr/Cellar/etc/workspace']
            ],
            [
                'fullpath',
                ['/home/usr/workspace', '/local/usr/Cellar/etc/workspace']
            ]
        ]
    ],
    'label' => 'Are you there ?',
    'id' => 320
]);

// Create query filters from framework request object
$result = \Drewlabs\Query\PreparesFiltersBag::new($request)->build(new TestModel);
```

- Here is a list of query methods supported by the package:

```
$methods = [
    'where',
    'whereHas',
    'whereDoesntHave',
    'whereDate',
    'has',
    'doesntHave',
    'whereIn',
    'whereNotIn',
    // Added where between query
    'whereBetween',
    'orWhere',
    'orderBy',
    'groupBy',
    'skip',
    'take',
    // Supporting joins queries
    'join',
    'rightJoin',
    'leftJoin',
    // Supporting whereNull and whereNotNull queries
    'whereNull',
    'orWhereNull',
    'whereNotNull',
    'orWhereNotNull'
]
```

**Warning** Entity objects/ Query models must implements the `Drewlabs\Query\Contracts\Queryable` interface for it to be compatible with query method calls.

The command API
---------------

[](#the-command-api)

The command API provides functions for sending query to database using the framework API under the hood.

```
use function Drewlabs\Laravel\Query\Proxy\useActionQueryCommand;
use function Drewlabs\Laravel\Query\Proxy\DMLManager;
use function Drewlabs\Laravel\Query\Proxy\SelectQueryAction;
use function Drewlabs\Support\Proxy\Action;

$command = useActionQueryCommand(Test::class);

// Calling command with an action using `call` method
$result = $command->call(SelectQueryAction($id));

// Calling the command using a callable interface
$result = $command(Action('SELECT' , $id));

// Creating and calling the the command API
useActionQueryCommand(Test::class)(SelectQueryAction($id));
```

### Select Query Action

[](#select-query-action)

`SelectQueryAction` Proxy function provides a typo free function for creating database query action of type `SELECT` .

- SelectQueryAction($id \[, array $columns, \\Closure $callback\])

```
use function Drewlabs\Laravel\Query\Proxy\SelectQueryAction;

// ...

// Example
$action = SelectQueryAction($id) // Creates a select by id query
```

- SelectQueryAction(array $query \[, array $columns, \\Closure $callback\])
- SelectQueryAction(array $query, int $per\_page \[?int $page = null, array $columns, \\Closure $callback\])

```
use function Drewlabs\Laravel\Query\Proxy\SelectQueryAction;

//...

// Example
$action = SelectQueryAction([ 'where' => ['id', 12] ]);
```

- SelectQueryAction(FiltersInterface $query \[, array $columns, \\Closure $callback\])
- SelectQueryAction(FiltersInterface $query, int $per\_page \[?int $page = null, array $columns, \\Closure $callback\])

```
use function Drewlabs\Laravel\Query\Proxy\CreateQueryFilters;
use function Drewlabs\Laravel\Query\Proxy\SelectQueryAction;

// ...
// Example
$action = SelectQueryAction(CreateQueryFilters(...));
```

### Update Query Action

[](#update-query-action)

`UpdateQueryAction` Proxy function provides a typo free function for creating database query action of type `UPDATE` .

- UpdateQueryAction($id, array|object $attributes \[, \\Closure $callback\])

```
use function Drewlabs\Laravel\Query\Proxy\UpdateQueryAction;

// ...

// Example
$action = UpdateQueryAction($id, ['name' => 'John Doe'])
```

- UpdateQueryAction(array $query, array|object $attributes \[, \\Closure $callback\])

```
use function Drewlabs\Laravel\Query\Proxy\UpdateQueryAction;

// ...

// Example
$action = UpdateQueryAction(CreateQueryFilters(...), ['name' => 'John Doe'])
```

- UpdateQueryAction(FiltersInterface $query, array|object $attributes \[, \\Closure $callback\])

```
use function Drewlabs\Laravel\Query\Proxy\UpdateQueryAction;
use function Drewlabs\Laravel\Query\Proxy\CreateQueryFilters;

// ...

// Example
$action = UpdateQueryAction(['where' => ['id' => 3]], ['name' => 'John Doe'])
```

### Delete Query Action

[](#delete-query-action)

Creates a `DELETE` type query action using user provided by function user.

- DeleteQueryAction($id \[, \\Closure $callback\])

```
use function Drewlabs\Laravel\Query\Proxy\DeleteQueryAction;

// ...

// Example
$action = DeleteQueryAction($id)
```

- DeleteQueryAction(array $query \[, \\Closure $callback\])

```
use function Drewlabs\Laravel\Query\Proxy\DeleteQueryAction;

// ...

// Example
$action = DeleteQueryAction(['where' => ['id' => 3]])
```

- DeleteQueryAction(FiltersInterface $query \[, \\Closure $callback\])

```
use function Drewlabs\Laravel\Query\Proxy\DeleteQueryAction;
use function Drewlabs\Laravel\Query\Proxy\CreateQueryFilters;

// ...

// Example
$action = DeleteQueryAction(CreateQueryFilters(...))
```

### Create Query Action

[](#create-query-action)

Creates a `CREATE` type query action using user provided by function user

- CreateQueryAction(array $attributes \[, array $params, \\Closure $callback\])

```
use function Drewlabs\Laravel\Query\Proxy\CreateQueryAction;

// ...

// Example
$action = CreateQueryAction([...])
```

- CreateQueryAction(object $attributes, \[, array $params , \\Closure $callback\])

```
use function Drewlabs\Laravel\Query\Proxy\CreateQueryAction;

// ...

// Example
$object = new stdClass;
$object->name = 'John Doe';
$object->notes = 67;

$action = CreateQueryAction($object);
```

**Note**To allow the creator function be more customizable, the function supports a second parameter that allow developpers to provides their own custom action handler.

```
use function Drewlabs\Laravel\Query\Proxy\useActionQueryCommand;
use function Drewlabs\Laravel\Query\Proxy\DMLManager;
use use Drewlabs\Contracts\Support\Actions\Action;

$command = useActionQueryCommand(TestModel::class, function(Action $action, ?\Closure $callback = null) {
     // Provides custom action handlers
});
```

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance53

Moderate activity, may be stable

Popularity13

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity52

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~16 days

Recently: every ~29 days

Total

48

Last Release

325d ago

PHP version history (3 changes)v0.2.0PHP ^7.2|^7.3|^7.4|^8.0|^8.1|^8.2

v0.2.10PHP >=7.2

v0.3.0PHP ^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/48c4973d500c7f4233d5ceacab51a57208d5fb60b0f95ae60264cf92380d0534?d=identicon)[azandrew-sidoine](/maintainers/azandrew-sidoine)

---

Top Contributors

[![azandrew-sidoine](https://avatars.githubusercontent.com/u/23530515?v=4)](https://github.com/azandrew-sidoine "azandrew-sidoine (382 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/drewlabs-laravel-query/health.svg)

```
[![Health](https://phpackages.com/badges/drewlabs-laravel-query/health.svg)](https://phpackages.com/packages/drewlabs-laravel-query)
```

###  Alternatives

[tucker-eric/eloquentfilter

An Eloquent way to filter Eloquent Models

1.8k4.8M26](/packages/tucker-eric-eloquentfilter)[owen-it/laravel-auditing

Audit changes of your Eloquent models in Laravel

3.4k33.0M95](/packages/owen-it-laravel-auditing)[yajra/laravel-oci8

Oracle DB driver for Laravel via OCI8

8703.0M17](/packages/yajra-laravel-oci8)[mehdi-fathi/eloquent-filter

Eloquent Filter adds custom filters automatically to your Eloquent Models in Laravel.It's easy to use and fully dynamic, just with sending the Query Strings to it.

450191.6k1](/packages/mehdi-fathi-eloquent-filter)[sleimanx2/plastic

Plastic is an Elasticsearch ODM and mapper for Laravel. It renders the developer experience more enjoyable while using Elasticsearch by providing a fluent syntax for mapping , querying and storing eloquent models.

508141.9k1](/packages/sleimanx2-plastic)[ntanduy/cloudflare-d1-database

Easy configuration and setup for D1 Database connections in Laravel.

215.4k](/packages/ntanduy-cloudflare-d1-database)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)