Merge pull request #1 from devmakerlab/(feat)readme.md

Creation of readme.md

Author: meinder-a

composer.json

@@ -24,6 +24,7 @@
         }
     ],
     "require": {
+        "php": "^7.4|^8.0",
         "illuminate/database": "^8.50"
     },
     "require-dev": {

readme.md

@@ -0,0 +1,109 @@
+<p align="center">
+<img src="https://user-images.githubusercontent.com/51158042/126819815-69be48fa-40a8-49e4-81ca-d3ebc1d3d521.png">
+</p>
+
+# DevMakerLab/Laravel-Filters
+
+Need some filters? This package is based on the Repository Design Pattern to let you create specific queries easily.
+
+* [Installation](#installation)
+* [Usage](#usage)
+* [Example](#example)
+
+## Installation
+<small>⚠️ Requires >= PHP 7.4 ⚠️</small>
+```shell
+composer require devmakerlab/laravel-filters
+```
+
+## Usage
+
+This package offers an abstract class `AbstractFilterableRepository` which needs to be extended to implement the features of this package.
+
+PeopleRepository.php
+```php
+<?php
+
+declare(strict_types=1);
+
+use DevMakerLab\LaravelFilters\AbstractFilterableRepository;
+
+class PeopleRepository extends AbstractFilterableRepository
+{
+    private DatabaseManager $databaseManager;
+
+    public function __construct(DatabaseManager $databaseManager)
+    {
+        $this->databaseManager = $databaseManager;
+    }
+
+    public function get(array $args): array
+    {
+        $queryBuilder = $this->databaseManager->table('people')
+            ->select(['firstname', 'lastname', 'age', 'gender']);
+
+        $this->applyFilters($queryBuilder, $args);
+
+        $people = $queryBuilder->get();
+
+        return $this->transform($people);
+    }
+
+    public function transform(Collection $people): array
+    {
+        $people->transform(function ($person) {
+            return [
+                'name' => sprintf('%s %s', $person->lastname, $person->firstname),
+                'age' => $person->age,
+                'gender' => $person->gender,
+            ];
+        });
+
+        return $people->toArray();
+    }
+}
+```
+
+PeopleService.php
+```php
+<?php
+    ...
+    $peopleRepository = new PeopleRepository($databaseManager);
+    
+    $people = $peopleRepository
+            ->addFilter(OldPeopleFilter::class)
+            ->get(['age' => 60]);
+```
+
+OldPeopleFilter.php
+```php
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Database\Query\Builder;
+
+class OldPeopleFilter implements FilterInterface
+{
+    public static function neededKeys(): array
+    {
+        return ['age'];
+    }
+
+    public static function isApplicable(...$args): bool
+    {
+        return true;
+    }
+
+    public function apply(Builder &$queryBuilder, ...$args): void
+    {
+        $age = $args[0][self::neededKeys()[0]];
+
+        $queryBuilder->where('age', '>=', $age);
+    }
+}
+```
+
+## Example
+
+[Usage Example](https://github.com/devmakerlab/laravel-filters/tree/master/tests/Example) of DevMakerLab/Laravel-Filters package.