Allow filters on related models (#43)

* Allow filtering on related fields

* Updated readme for filter fields

* Apply fixes from StyleCI (#44)

Co-authored-by: Craig Smith <[email protected]>

Author: samatcd

README.md

@@ -127,6 +127,10 @@ protected static $allowedScopes = [
 
 Given the above `$allowedScopes` array, your API consumers will now be able to request `?fullname=John`. The query parameter value will be passed to your scope function in your Eloquent Model.
 
+## Filtering on related models
+
+You can easily filter using any related model that is configured for `include`. Simply specify `?filter[model.field]=123` in your query string. The same filter options above apply to related fields.
+
 
 # Fields, Relationships, Sorting & Pagination
 
@@ -141,7 +145,16 @@ By default all fields are returned, you can limit that to specific fields in the
 
 ## Relationships
 
-* Using the relationships defined in your models, you can pass a comma delimited list eg `include=join1,join2` which will return those joins (one or many)
+* Using the relationships defined in your models, you can pass a comma delimited list eg `include=join1,join2` which will return those joins (one or many).
+
+Simply add a `protected static $mapResources` to your `Resource` to define which resources to assign your related data. E.e., for a one to many relationship, you should specify a collection, and a one-to-one relationship specify the related resource directly. This will allow the API to properly format the related record.
+
+```
+    protected static $mapResources = [
+        'notes' => NotesCollection::class,
+        'owner' => OwnerResource::class
+    ];
+```
 
 ## Sorting
 

src/Contracts/Parser.php

@@ -127,8 +127,8 @@ protected function parseFilterParams(): void
 
         foreach ($where as $whr) {
             if (strpos($whr['key'], '.') > 0) {
-                //@TODO: test if exists in the withs, if not continue out to exclude from the qbuild
-                //continue;
+                $this->setWhereHasClause($whr);
+                continue;
             } elseif (! in_array($whr['key'], $tableColumns)) {
                 continue;
             }
@@ -151,12 +151,42 @@ protected function parseMethodParams($request): void
         }
     }
 
+    protected function setWhereHasClause(array $where): void
+    {
+        [$with, $key] = explode('.', $where['key']);
+
+        $sub = self::$model->{$with}()->getRelated();
+        $fields = $this->getTableColumns($sub);
+
+        if (! in_array($key, $fields)) {
+            return;
+        }
+
+        $this->repository->whereHas($with, function ($q) use ($where, $key) {
+            switch ($where['type']) {
+                case 'In':
+                    if (! empty($where['values'])) {
+                        $q->whereIn($key, $where['values']);
+                    }
+                    break;
+                case 'NotIn':
+                    if (! empty($where['values'])) {
+                        $q->whereNotIn($key, $where['values']);
+                    }
+                    break;
+                case 'Basic':
+                        $q->where($key, $where['value'], $where['operator']);
+                    break;
+            }
+        });
+    }
+
     /**
      * set the Where clause.
      *
      * @param array $where the where clause
      */
-    protected function setWhereClause($where): void
+    protected function setWhereClause(array $where): void
     {
         switch ($where['type']) {
             case 'In':

src/Repository/BaseRepository.php

@@ -403,7 +403,7 @@ public function with($relations)
             $relations = func_get_args();
         }
 
-        $this->with = $relations;
+        $this->with = array_unique(array_merge($this->with, $relations));
 
         return $this;
     }