wip

Author: oniice

docs/stategies.md

@@ -5,14 +5,18 @@
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Http\Request;
+use Illuminate\Pagination\LengthAwarePaginator;
 use Myerscode\Laravel\QueryStrategies\Exceptions\BuilderNotFoundException;
 use Myerscode\Laravel\QueryStrategies\Exceptions\BuilderNotSetException;
 use Myerscode\Laravel\QueryStrategies\Exceptions\FilterStrategyNotFoundException;
 use Myerscode\Laravel\QueryStrategies\Exceptions\InvalidStrategyException;
+use Myerscode\Laravel\QueryStrategies\Strategies\DefaultModelStrategy;
+use Myerscode\Laravel\QueryStrategies\Strategies\StrategyInterface;
 
 class FilterBuilder
 {
 
+    private ?Model $model = null;
     private ?Builder $builder = null;
 
 
@@ -32,10 +36,12 @@ private function setBuilder($builderOrModel): void
         if (empty($builderOrModel)) {
             throw new BuilderNotSetException();
         }
+        dd("$builderOrModel instanceof Model");
 
         if ($builderOrModel instanceof Builder) {
             $this->builder = $builderOrModel;
         } elseif ($builderOrModel instanceof Model) {
+            $this->model = $builderOrModel;
             $this->builder = $builderOrModel->newQuery();
         } elseif (is_string($builderOrModel) && class_exists($builderOrModel) && ($model = app($builderOrModel)) instanceof Model) {
             $this->builder = $model->query();
@@ -66,12 +72,14 @@ public function filter($builderOrModel): FilterBuilder
     /**
      * Apply a possible strategy by name or a given class
      *
-     * @param  $possibleStrategy
+     * @param  string|StrategyInterface|null  $possibleStrategy
+     *
+     * @return Filter
+     * @throws BuilderNotSetException
      * @throws FilterStrategyNotFoundException
      * @throws InvalidStrategyException
-     * @throws BuilderNotSetException
      */
-    public function with($possibleStrategy): Filter
+    public function with(string|StrategyInterface|array $possibleStrategy): Filter
     {
         if (!$this->builder instanceof Builder) {
             throw new BuilderNotSetException();
@@ -81,6 +89,30 @@ public function with($possibleStrategy): Filter
         return new Filter($this->builder, $strategy, $this->request->query->all(), $this->config());
     }
 
+    protected function hasFilterTrait(): bool
+    {
+        $usedTraits = class_uses($this->model);
+
+        return $usedTraits && in_array(IsFilterableTrait::class, $usedTraits);
+    }
+
+    /**
+     * @throws BuilderNotSetException
+     * @throws FilterStrategyNotFoundException
+     * @throws InvalidStrategyException
+     */
+    public function results(string|StrategyInterface|array|null $possibleStrategy = null): LengthAwarePaginator
+    {
+        dd( ($this->model instanceof Model) );
+        dd($this->model->strategyConfig);
+
+        if (is_null($possibleStrategy) && ($this->model instanceof Model) && isset($this->model->strategyConfig)) {
+            $possibleStrategy = DefaultModelStrategy::fromConfig($this->model->strategyConfig);
+        }
+
+        return $this->with($possibleStrategy)->apply();
+    }
+
     /**
      * The config the will be built eiyh
      * @return array{order: mixed, sort: mixed, limit: mixed, page: mixed, with: mixed}

src/FilterBuilder.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Myerscode\Laravel\QueryStrategies\Strategies;
+
+use Illuminate\Database\Eloquent\Model;
+
+class DefaultModelStrategy extends Strategy
+{
+
+    public function __construct(protected array $parameters)
+    {
+        parent::__construct();
+    }
+
+    public static function fromConfig(array $config): DefaultModelStrategy
+    {
+        return new self($config);
+    }
+}

src/Strategies/DefaultModelStrategy.php

@@ -23,7 +23,7 @@ class Strategy implements StrategyInterface
      *
      * @var []
      */
-    protected $config = [
+    protected array $config = [
         //
     ];
 
@@ -32,7 +32,7 @@ class Strategy implements StrategyInterface
      *
      * @var Parameter[]
      */
-    protected $parameters = [
+    protected array $parameters = [
         //
     ];
 
@@ -41,7 +41,7 @@ class Strategy implements StrategyInterface
      *
      * @var array
      */
-    protected $defaultMethods = [
+    protected array $defaultMethods = [
         BeginsWithClause::class => ['beginsWith', '*%'],
         ContainsClause::class => ['contains', '%%'],
         EndsWithClause::class => ['endsWith', '%*'],
@@ -61,21 +61,21 @@ class Strategy implements StrategyInterface
      *
      * @var int
      */
-    protected $limitTo = 50;
+    protected int $limitTo = 50;
 
     /**
      * Maximum number of records a api response can have
      *
      * @var int
      */
-    protected $maxLimit = 150;
+    protected int $maxLimit = 150;
 
     /**
      * The model which to apply this strategy to
      *
      * @var []
      */
-    protected $canOrderBy = [
+    protected array $canOrderBy = [
         'id',
     ];
 

src/Strategies/Strategy.php

@@ -2,6 +2,7 @@
 
 namespace Myerscode\Laravel\QueryStrategies;
 
+use Illuminate\Database\Eloquent\Model;
 use Myerscode\Laravel\QueryStrategies\Exceptions\FilterStrategyNotFoundException;
 use Myerscode\Laravel\QueryStrategies\Exceptions\InvalidStrategyException;
 use Myerscode\Laravel\QueryStrategies\Strategies\StrategyInterface;
@@ -14,11 +15,13 @@ class StrategyManager
     private array $cache = [];
 
     /**
-     * @param  $possibleStrategy
+     * @param  string|StrategyInterface|Model  $possibleStrategy
+     *
+     * @return StrategyInterface
      * @throws FilterStrategyNotFoundException
      * @throws InvalidStrategyException
      */
-    public function findStrategy($possibleStrategy): StrategyInterface
+    public function findStrategy(string|StrategyInterface|Model $possibleStrategy): StrategyInterface
     {
         $possibleStrategyName = is_object($possibleStrategy) ? $possibleStrategy::class : $possibleStrategy;
 
@@ -39,6 +42,11 @@ public function findStrategy($possibleStrategy): StrategyInterface
         return $this->cache[$cacheName];
     }
 
+    public function buildDefaultStrategy(string $strategy): StrategyInterface
+    {
+
+    }
+
     /**
      * Create a safe slug for caching the strategy
      *

src/StrategyManager.php

@@ -11,6 +11,7 @@
 use Myerscode\Laravel\QueryStrategies\FilterBuilder;
 use Myerscode\Laravel\QueryStrategies\StrategyManager;
 use Tests\Support\Models\Item;
+use Tests\Support\Models\Record;
 use Tests\Support\Models\Register;
 use Tests\Support\Models\TodoList;
 use Tests\Support\Strategies\ComplexConfigQueryStrategy;
@@ -80,6 +81,11 @@ public function testCanFindBuilderFromBuilder(): void
         $this->assertInstanceOf(Builder::class, $filterBuilder->builder());
     }
 
+    public function testCanFilterUsingModelConfigForStrategy(): void
+    {
+        filter(Record::class)->results();
+    }
+
     public function testFilterWithReturnsInstanceOfFilter(): void
     {
         $filterBuilder = new FilterBuilder( new Request(), new StrategyManager());