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.
composer require williamoliveira/eloquent-array-query-builder
We let the wiring of the request to the model to you, so you can use it wherever you want.
Example in a controller:
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:
// 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(); //instanceHere is a example of what a query can look like:
$exampleArrayQuery = [
'where' => [
'name' => ['like' => '%joao%'],
'created_at' => [
'between' => [
'2014-10-10',
'2015-10-10',
],
],
'or' => [ // nested boolean where clauses
'foo' => 'bar',
'baz' => 'qux',
],
],
'scopes' => 'hotAndPopular',
'has' => ['comments', 'author'],
'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
&scopes=hotAndPopular
&has[]=comments
&has[]=author
&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.
'eq' => '=',
'neq' => '<>',
'gt' => '>',
'gte' => '>=',
'lt' => '<',
'lte' => '<=',
'nlike' => 'not like',
'nin' => 'not in',
'notnull' => 'not null',
'nn' => 'not null',
'inq' => 'in'