wip

Author: semiherdogan

README.md

@@ -2,12 +2,14 @@
 
 Create and use eloquent filters easily.
 
+This package idea comes from [Laracasts lets build a forum with laravel](https://laracasts.com/series/lets-build-a-forum-with-laravel) series. 
+
 # Installation
 
 You can install the package via composer:
 
 ```bash
-$ composer require laratoolbox/database-viewer
+$ composer require laratoolbox/eloquent-filters
 ```
 
 # Usage
@@ -18,16 +20,21 @@ First create filter like below.
 php artisan make:filter UserFilter
 ```
 
-After creating the filter, add Filter trait into your eloquent model.
+After creating the filter, add EloquentFilter trait into your eloquent model.
 
 ```php
-use \LaraToolbox\EloquentFilters\Traits\Filters;
+use \LaraToolbox\EloquentFilters\HasFilter;
 ```
 
 Then you may use filter like below.
 
 ```php
-MyEloquentModel::filter( new UserFilter(request()) )->get();
+MyEloquentModel::filter( new UserFilter() )->get();
+
+// or you can give request instance into filter.
+
+$request = request();
+MyEloquentModel::filter( new UserFilter($request) )->get();
 ```
 
 # Testing

src/Commands/MakeFilter.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace LaraToolbox\EloquentFilters\Commands;
+
+use Illuminate\Console\GeneratorCommand;
+
+class MakeFilterCommand extends GeneratorCommand
+{
+    protected $name = 'make:filter';
+
+    protected $description = 'Create a new filter class';
+
+    protected $type = 'Filter';
+
+    protected function getStub()
+    {
+        return __DIR__.'/stubs/filter.stub';
+    }
+
+    protected function getDefaultNamespace($rootNamespace)
+    {
+        return $rootNamespace.'\Filters';
+    }
+
+    public function handle()
+    {
+        parent::handle();
+
+        $this->info('Add this trait to your model for using filters:');
+        $this->info('use \LaraToolbox\EloquentFilters\HasFilter;');
+    }
+}

src/Commands/MakeFilterCommand.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace {{ namespace }};
+
+use LaraToolbox\EloquentFilters\Filters;
+
+class {{ class }} extends Filters
+{
+    protected $filters = [
+        // 'name'
+    ];
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    protected function name()
+    {
+        // return $this->builder->where('name', 'LIKE', sprintf('%%%s%%', $this->request->name));
+    }
+}

src/Commands/stubs/filter.stub

@@ -2,10 +2,10 @@
 
 namespace LaraToolbox\EloquentFilters;
 
-abstract class FilterBase
+abstract class Filters
 {
     /**
-     * @var Request
+     * @var \Illuminate\Http\Request
      */
     protected $request;
 
@@ -24,7 +24,7 @@ abstract class FilterBase
     protected $filters = [];
 
     /**
-     * Create a new ThreadFilters instance.
+     * Create a new Filter instance.
      *
      * @param  \Illuminate\Http\Request  $request
      */
@@ -41,7 +41,6 @@ public function __construct($request = null)
      * Apply the filters.
      *
      * @param  \Illuminate\Database\Eloquent\Builder  $builder
-     *
      * @return \Illuminate\Database\Eloquent\Builder
      */
     public function apply($builder)

src/EloquentFilters.php renamed to src/Filters.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace LaraToolbox\EloquentFilters;
+
+trait HasFilter
+{
+    /**
+     * Apply all relevant filters.
+     *
+     * @param  \Illuminate\Database\Eloquent\Builder  $query
+     * @param  $filter
+     *
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function scopeFilter($query, $filter)
+    {
+        if (!is_subclass_of($filter, \LaraToolbox\EloquentFilters\Filters::class)) {
+            // TODO: throw exception here!
+        }
+
+        return $filter->apply($query);
+    }
+}

src/HasFilter.php

@@ -3,7 +3,7 @@
 namespace LaraToolbox\EloquentFilters;
 
 use Illuminate\Support\ServiceProvider;
-use LaraToolbox\EloquentFilters\Commands\MakeFilter;
+use LaraToolbox\EloquentFilters\Commands\MakeFilterCommand;
 
 class PackageServiceProvider extends ServiceProvider
 {
@@ -14,7 +14,7 @@ public function boot()
     {
         if ($this->app->runningInConsole()) {
             $this->commands([
-                MakeFilter::class,
+                MakeFilterCommand::class,
             ]);
         }
     }