Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/williamoliveira/eloquent-array-query-builder
Query Laravel Eloquent with and associative array
https://github.com/williamoliveira/eloquent-array-query-builder
eloquent laravel laravel5 php query-builder
Last synced: 7 days ago
JSON representation
Query Laravel Eloquent with and associative array
- Host: GitHub
- URL: https://github.com/williamoliveira/eloquent-array-query-builder
- Owner: williamoliveira
- Created: 2016-03-06T21:40:35.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-08-18T20:08:28.000Z (about 4 years ago)
- Last Synced: 2024-04-20T21:32:59.147Z (6 months ago)
- Topics: eloquent, laravel, laravel5, php, query-builder
- Language: PHP
- Homepage:
- Size: 43 KB
- Stars: 17
- Watchers: 6
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://travis-ci.org/williamoliveira/eloquent-array-query-builder)
[](https://packagist.org/packages/williamoliveira/eloquent-array-query-builder)
[](https://packagist.org/packages/williamoliveira/eloquent-array-query-builder)
[](https://packagist.org/packages/williamoliveira/eloquent-array-query-builder)
## Why this nonsense?
So you can have easy to use query "language" to query your data, without the need to write long conditional queries by hand, very useful for REST APIs.
## How to install
`composer require williamoliveira/eloquent-array-query-builder`
## How to use
We let the wiring of the request to the model to you, so you can use it wherever you want.
Example in a controller:
```php
public function index(Request $request, \Williamoliveira\ArrayQueryBuilder\ArrayBuilder $arrayBuilder)
{
$query = User::query();
$query = $arrayBuilder->apply($query, $request->all());
return $query->paginate($request->get('per_page')); // Note it does not do pagination or call get(),
// you need to do it yourself
}
```
You can also use the ArrayQueryable trait in your model:
```php
// Model
class User extends Model{
use \Williamoliveira\ArrayQueryBuilder\Traits\ArrayQueryable;
// ...
// Usage
return User::arrayQuery($request->all())->get(); //static
return (new User())->newArrayQuery($request->all())->get(); //instance
```
#### Query format
Here is a example of what a query can look like:
```php
$exampleArrayQuery = [
'where' => [
'name' => ['like' => '%joao%'],
'created_at' => [
'between' => [
'2014-10-10',
'2015-10-10',
],
],
'or' => [ // nested boolean where clauses
'foo' => 'bar',
'baz' => 'qux',
],
],
'fields' => ['id', 'name', 'created_at'],
'order' => 'name',
'include' => [ // relations, can have where, order and fields
'permissions' => true,
'roles' => [
'where' => [
'name' => 'admin',
],
'fields' => ['id', 'name'],
'order' => 'name DESC',
],
],
'groupBy' => ['foo', 'bar', 'baz'],
'having' => [
'foo' => 'x',
'bar' => ['in' => ['1', '2']],
'baz' => ['neq' => '3'],
],
'offset' => 5,
'limit' => 15,
];
```
Just as a reference to people building REST APIs, the same query as a query string:
```
?where[name][like]=%joao%
&where[created_at][between][]=2014-10-10
&where[created_at][between][]=2015-10-10
&where[or][foo]=bar
&where[or][baz]=qux
&fields[]=id
&fields[]=name
&fields[]=created_at
&order=name
&include[permissions]=true
&include[roles][where][name]=admin
&include[roles][fields][]=id
&include[roles][fields][]=name
&include[roles][order]=name DESC
&groupBy[]=foo
&groupBy[]=bar
&groupBy[]=baz
&having[foo]=x
&having[bar][in][]=1
&having[bar][in][]=2
&having[baz][neq]=3
&offset=5
&limit=15
```
Tip: for Javascript you can create a query string using [Qs](https://github.com/ljharb/qs).
#### Where/Having operators aliases
```
'eq' => '=',
'neq' => '<>',
'gt' => '>',
'gte' => '>=',
'lt' => '<',
'lte' => '<=',
'nlike' => 'not like',
'nin' => 'not in',
'notnull' => 'not null',
'nn' => 'not null',
'inq' => 'in'
```