Initial commit

Author: Yordi de Kleijn

.gitignore

@@ -0,0 +1 @@
+.idea

composer.json

@@ -0,0 +1,33 @@
+{
+    "name": "temperworks/laravel-filter-scopes",
+    "description": "Seperate model filters into reusable scopes that map into the right filters based on URL params.",
+    "type": "package",
+    "homepage": "https://github.com/temperworks/laravel-filter-scopes",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Yordi de Kleijn",
+            "email": "yordi@temper.works",
+            "homepage": "https://temper.works",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php" : ">=5.5.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit" : "4.*"
+    },
+    "autoload": {
+        "psr-4": {
+            "TemperWorks\\FilterScopes\\": "src"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+
+            ]
+        }
+    }
+}

src/QueryFilters.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace TemperWorks\FilterScopes;
+
+use Illuminate\Http\Request;
+use Illuminate\Database\Eloquent\Builder;
+
+abstract class QueryFilters
+{
+    /**
+     * The request object.
+     *
+     * @var Request
+     */
+    protected $request;
+
+    /**
+     * The builder instance.
+     *
+     * @var Builder
+     */
+    protected $builder;
+
+    /**
+     * Create a new QueryFilters instance.
+     *
+     * @param Request $request
+     */
+    public function __construct(Request $request)
+    {
+        $this->request = $request;
+    }
+
+    /**
+     * Apply the filters to the builder.
+     *
+     * @param  Builder $builder
+     * @return Builder
+     */
+    public function apply(Builder $builder): Builder
+    {
+        $this->builder = $builder;
+
+        foreach ($this->filters() as $name => $value) {
+            if (isset($this->lookup)) {
+                $name = isset($this->lookup[$name]) ? $this->lookup[$name] : $name;
+            }
+
+            if (! method_exists($this, $name)) {
+                continue;
+            }
+
+            if ($value && strlen($value)) {
+                $this->$name($value);
+            } else {
+                $this->$name();
+            }
+        }
+
+        return $this->builder;
+    }
+
+    /**
+     * Get all request filters data.
+     *
+     * @return array
+     */
+    public function filters(): array
+    {
+        return $this->request->all();
+    }
+
+    public function overrideRequest(Request $request)
+    {
+        $this->request = $request;
+    }
+}

src/Traits/Filterable.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace TemperWorks\FilterScopes\Traits;
+
+use Illuminate\Database\Eloquent\Builder;
+use TemperWorks\FilterScopes\QueryFilters;
+
+trait Filterable
+{
+    /**
+     * Filter a result set.
+     *
+     * @param Builder $query
+     * @param QueryFilters $filters
+     * @return Builder
+     */
+    public function scopeFilter(Builder $query, QueryFilters $filters): Builder
+    {
+        return $filters->apply($query);
+    }
+}

src/Traits/ParseArrayInput.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace TemperWorks\FilterScopes\Traits;
+
+trait ParseArrayInput {
+
+    public function parseInput($input)
+    {
+        return explode(',', $input);
+    }
+}

src/Traits/ParseDateArrayInput.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace TemperWorks\FilterScopes\Traits;
+
+use Carbon\Carbon;
+
+trait ParseDateArrayInput {
+
+    /**
+     * Parse scope input
+     *
+     * @param $input
+     * @return array
+     */
+    public function parseInput($input)
+    {
+        $dates = explode(',', $input);
+
+        return array_map(function ($date) {
+            return Carbon::parse($date)->startOfDay()->toDateString();
+        }, $dates);
+    }
+}

src/Traits/ValidateArrayInput.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace TemperWorks\FilterScopes\Traits;
+
+use Validator;
+
+trait ValidateArrayInput {
+    /**
+     * Validate given scope input
+     *
+     * @param $input
+     * @param array $extend
+     * @param string $originalResourceKey
+     * @return bool
+     */
+    public function validate($input, $extend = [], $originalResourceKey = 'input')
+    {
+        $input = [$originalResourceKey => $input];
+
+        Validator::make($input, array_merge([
+            $originalResourceKey => 'array'
+        ], $extend))->validate();
+
+        return true;
+    }
+}

src/Traits/ValidateInput.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace TemperWorks\FilterScopes\Traits;
+
+use Validator;
+
+trait ValidateInput {
+    /**
+     * Validate given scope input
+     *
+     * @param $input
+     * @param array $extend
+     * @param string $originalResourceKey
+     * @return bool
+     */
+    public function validate($input, $extend = [], $originalResourceKey = 'input')
+    {
+        $input = [$originalResourceKey => $input];
+
+        Validator::make($input, $extend)->validate();
+
+        return true;
+    }
+}