init

Author: semiherdogan

.gitignore

@@ -0,0 +1,2 @@
+/.idea
+/.vscode

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Laravel Eloquent Filters
+
+Create eloquent filters easily
+
+```shell
+php artisan make:filter UserFilter
+```

README.md

@@ -0,0 +1,52 @@
+{
+    "name": "laratoolbox/eloquent-filters",
+    "description": "Add filters to eloquent models",
+    "keywords": [
+        "laratoolbox",
+        "eloquent",
+        "filters"
+    ],
+    "homepage": "https://github.com/laratoolbox/eloquent-filters",
+    "license": "MIT",
+    "type": "library",
+    "authors": [
+        {
+            "name": "Semih ERDOGAN",
+            "email": "[email protected]",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": ">=7.0",
+        "illuminate/support": "^5.5|^5.6|^5.7|^5.8|^6.0|^7.0|^8.0"
+    },
+    "require-dev": {
+        "orchestra/testbench": "^3.5|^3.6|^3.7|^3.8|^4.0|^5.0|^6.0",
+        "phpunit/phpunit": "~6.0|^7.0|^7.5|^8.4|^9.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "LaraToolbox\\EloquentFilters\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "LaraToolbox\\EloquentFilters\\Tests\\": "tests"
+        }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit",
+        "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
+
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "LaraToolbox\\EloquentFilters\\PackageServiceProvider"
+            ]
+        }
+    }
+}

composer.json

@@ -0,0 +1,62 @@
+<?php
+
+namespace LaraToolbox\EloquentFilters\Commands;
+
+use Illuminate\Console\Command;
+
+class ShowTableColumnsCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'make:filter';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Create a new filter class';
+
+    /**
+     * Create a new command instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        parent::__construct();
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle()
+    {
+        $filterClass = $this->option('name');
+
+        $filterContent = str_replace(
+            [
+                '{namespace}',
+                '{className}',
+            ],
+            [
+                config('eloquent_filters.namespace', 'App\Filters'),
+                $filterClass,
+            ],
+            file_get_contents('../stub/filter.stub') // TODO: make stub customizable
+        );
+
+        file_put_contents(
+            "$filterClass.php",
+            config('eloquent_filters.base_folder', app_path('Filters'))
+        );
+
+        $this->info('Filter created.');
+        return 0;
+    }
+}

src/Commands/MakeFilter.php

@@ -0,0 +1,83 @@
+<?php
+
+namespace LaraToolbox\EloquentFilters;
+
+abstract class FilterBase
+{
+    /**
+     * @var Request
+     */
+    protected $request;
+
+    /**
+     * The Eloquent builder.
+     *
+     * @var \Illuminate\Database\Eloquent\Builder
+     */
+    protected $builder;
+
+    /**
+     * Registered filters to operate upon.
+     *
+     * @var array
+     */
+    protected $filters = [];
+
+    /**
+     * Create a new ThreadFilters instance.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     */
+    public function __construct($request = null)
+    {
+        if (is_null($request)) {
+            $request = request();
+        }
+
+        $this->request = $request;
+    }
+
+    /**
+     * Apply the filters.
+     *
+     * @param  \Illuminate\Database\Eloquent\Builder  $builder
+     *
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function apply($builder)
+    {
+        $this->builder = $builder;
+
+        foreach ($this->getFilters() as $filter => $value) {
+            if (method_exists($this, $filter)) {
+                $this->$filter($value);
+            }
+        }
+
+        return $this->builder;
+    }
+
+    /**
+     * Fetch all relevant filters from the request.
+     *
+     * @return array
+     */
+    public function getFilters()
+    {
+        return array_filter($this->request->only($this->filters), function ($value) {
+            if (is_null($value)) {
+                return false;
+            }
+
+            if ($value === '') {
+                return false;
+            }
+
+            if (is_array($value) && count($value) === 0) {
+                return false;
+            }
+
+            return true;
+        });
+    }
+}

src/EloquentFilters.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace LaraToolbox\EloquentFilters;
+
+use Illuminate\Support\ServiceProvider;
+use LaraToolbox\EloquentFilters\Commands\MakeFilter;
+
+class DatabaseViewerServiceProvider extends ServiceProvider
+{
+    /**
+     * Bootstrap the application services.
+     */
+    public function boot()
+    {
+        if ($this->app->runningInConsole()) {
+            $this->commands([
+                MakeFilter::class,
+            ]);
+        }
+    }
+
+    /**
+     * Register the application services.
+     */
+    public function register()
+    {
+        //
+    }
+}

src/PackageServiceProvider.php

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

src/Trait/Filter.php

@@ -0,0 +1,7 @@
+<?php
+
+return [
+    'namespace' => 'App\Filters',
+
+    'base_folder' => app_path('Filters'),
+];

src/config/eloquent_filters.php

@@ -0,0 +1,23 @@
+namespace {namespace};
+
+use LaraToolbox\EloquentFilters\FilterBase;
+
+class {className} extends FilterBase
+{
+    /**
+     * Registered filters to operate upon.
+     *
+     * @var array
+     */
+    protected $filters = [
+        'example'
+    ];
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    protected function example()
+    {
+        // return $this->builder->where('', '');
+    }
+}