Group by added (#10)

* Group by added

* Apply fixes from StyleCI (#9)

Author: Norgul

README.md

@@ -51,6 +51,7 @@ JSON parameters (keys):
 - ``search`` - will perform the querying logic (explained in detail [below](#search))
 - ``returns`` - will return only the columns provided as values.
 - ``order_by`` - will order the results based on values provided.
+- ``group_by`` - will group the results based on values provided.
 - ``relations`` - will load the relations for the given model.
 - `limit` - will limit the results returned.
 - `offset` - will return a subset of results starting from a point given. This parameter **MUST**
@@ -185,6 +186,25 @@ Example:
 
 Will perform a ``SELECT ... ORDER BY first_name asc, last_name desc``
 
+### Group by
+
+Using ``group_by`` key does an 'group by' based on the given key(s). Order of the keys
+matters!
+
+Arguments are presumed to be a single attribute or array of attributes.
+
+Since group by behaves like it would in a plain SQL query, be sure to select
+the right fields and aggregate functions. 
+
+Example:
+```
+{
+    "group_by": ["last_name", "first_name"]
+}
+```
+
+Will perform a ``SELECT ... GROUP BY last_name, first_name``
+
 ### Relations
 
 It is possible to load object relations as well by using ``relations`` parameter.

config/asseco-json-query-builder.php

@@ -1,6 +1,7 @@
 <?php
 
 use Asseco\JsonQueryBuilder\RequestParameters\CountParameter;
+use Asseco\JsonQueryBuilder\RequestParameters\GroupByParameter;
 use Asseco\JsonQueryBuilder\RequestParameters\LimitParameter;
 use Asseco\JsonQueryBuilder\RequestParameters\OffsetParameter;
 use Asseco\JsonQueryBuilder\RequestParameters\OrderByParameter;
@@ -30,6 +31,7 @@
         LimitParameter::class,
         OffsetParameter::class,
         CountParameter::class,
+        GroupByParameter::class,
     ],
 
     /**

src/RequestParameters/CountParameter.php

@@ -5,7 +5,6 @@
 namespace Asseco\JsonQueryBuilder\RequestParameters;
 
 use Asseco\JsonQueryBuilder\Exceptions\JsonQueryBuilderException;
-use Illuminate\Support\Facades\DB;
 
 class CountParameter extends AbstractParameter
 {
@@ -27,6 +26,6 @@ public function areArgumentsValid(): void
 
     public function appendQuery(): void
     {
-        $this->builder->select(DB::raw('count(*) as count'));
+        $this->builder->selectRaw('count(*) as count');
     }
 }

src/RequestParameters/GroupByParameter.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Asseco\JsonQueryBuilder\RequestParameters;
+
+class GroupByParameter extends AbstractParameter
+{
+    public static function getParameterName(): string
+    {
+        return 'group_by';
+    }
+
+    public function appendQuery(): void
+    {
+        $this->builder->groupBy($this->arguments);
+    }
+}

src/RequestParameters/RelationsParameter.php

@@ -42,7 +42,7 @@ protected function appendComplexRelation(array $argument): void
         $relation = key($argument);
         $input = $argument[$relation];
 
-        $this->builder->with([$relation => function ($query) use ($input) {
+        $this->builder->with([Str::camel($relation) => function ($query) use ($input) {
             $jsonQuery = new JsonQuery($query->getQuery(), $input);
             $jsonQuery->search();
         }]);