Allow the usage of more complex filter methods by Spatie\QueryBuilder

README.md

@@ -98,25 +98,28 @@ Token Resource is protected by TokenPolicy. You can disable it by publishing the
 ### Filtering & Allowed Field
 
 We used `"spatie/laravel-query-builder": "^5.3"` to handle query selecting, sorting and filtering. Check out [the spatie/laravel-query-builder documentation](https://spatie.be/docs/laravel-query-builder/v5/introduction) for more information.
-You can specified `allowedFilters` and `allowedFields` in your model. For example:
+
+In order to allow modifying the query for your model you can implement the `HasAllowedFields`, `HasAllowedSorts` and `HasAllowedFilters` Contracts in your model.
 
 ```php
-class User extends Model {
+class User extends Model implements HasAllowedFields, HasAllowedSorts, HasAllowedFilters {
     // Which fields can be selected from the database through the query string
-    public static array $allowedFields = [
-        'name'
-    ];
+    public function getAllowedFields(): array
+    {
+        // Your implementation here
+    }
 
     // Which fields can be used to sort the results through the query string
-    public static array $allowedSorts = [
-        'name',
-        'created_at'
-    ];
+    public function getAllowedSorts(): array
+    {
+        // Your implementation here
+    }
 
     // Which fields can be used to filter the results through the query string
-    public static array $allowedFilters = [
-        'name'
-    ];
+    public function getAllowedFilters(): array
+    {
+        // Your implementation here
+    }
 }
 ```
 

src/Contracts/HasAllowedFields.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rupadana\ApiService\Contracts;
+
+interface HasAllowedFields
+{
+    public static function getAllowedFields(): array;
+}

src/Contracts/HasAllowedFilters.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rupadana\ApiService\Contracts;
+
+interface HasAllowedFilters
+{
+    public static function getAllowedFilters(): array;
+}

src/Contracts/HasAllowedSorts.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rupadana\ApiService\Contracts;
+
+interface HasAllowedSorts
+{
+    public static function getAllowedSorts(): array;
+}

stubs/PaginationHandler.stub

@@ -17,10 +17,10 @@ class PaginationHandler extends Handlers {
         $model = static::getModel();
 
         $query = QueryBuilder::for($query)
-        ->allowedFields($model::$allowedFields ?? [])
-        ->allowedSorts($model::$allowedSorts ?? [])
-        ->allowedFilters($model::$allowedFilters ?? [])
-        ->allowedIncludes($model::$allowedIncludes ?? null)
+        ->allowedFields($model::getAllowedFields() ?? [])
+        ->allowedSorts($model::getAllowedSorts() ?? [])
+        ->allowedFilters($model::getAllowedFilters() ?? [])
+        ->allowedIncludes($model::getAllowedIncludes() ?? [])
         ->paginate(request()->query('per_page'))
         ->appends(request()->query());
 

tests/Fixtures/Resources/ProductResource/Api/Handlers/PaginationHandler.php

@@ -15,10 +15,28 @@ public function handler()
     {
         $model = static::getModel();
 
+        $allowedFields = method_exists($model, 'getAllowedFields') && is_array($model::getAllowedFields())
+            ? $model::getAllowedFields()
+            : (property_exists($model, 'allowedFields') && is_array($model::$allowedFields)
+                ? $model::$allowedFields
+                : []);
+
+        $allowedSorts = method_exists($model, 'getAllowedSorts') && is_array($model::getAllowedSorts())
+            ? $model::getAllowedSorts()
+            : (property_exists($model, 'allowedSorts') && is_array($model::$allowedSorts)
+                ? $model::$allowedSorts
+                : []);
+
+        $allowedFilters = method_exists($model, 'getAllowedFilters') && is_array($model::getAllowedFilters())
+            ? $model::getAllowedFilters()
+            : (property_exists($model, 'allowedFilters') && is_array($model::$allowedFilters)
+                ? $model::$allowedFilters
+                : []);
+
         $query = QueryBuilder::for($model)
-            ->allowedFields($model::$allowedFields ?? [])
-            ->allowedSorts($model::$allowedSorts ?? [])
-            ->allowedFilters($model::$allowedFilters ?? [])
+            ->allowedFields($allowedFields)
+            ->allowedSorts($allowedSorts)
+            ->allowedFilters($allowedFilters)
             ->paginate(request()->query('per_page'))
             ->appends(request()->query());