Laravel Query Filter using Pipeline

ALaravelPipelineReadme.md

Laravel Query Filter using Pipeline

Basically, with a pipeline we can pass an object through a stack of tasks and get the result via a callback.

Refer Here -> https://laravel.com/api/7.x/Illuminate/Pipeline/Pipeline.html

The method handle used to execute the task receives two parameters, the first is the object that we passed to our pipeline, the second is a closure, where the object will be sent to run the next task.

Before pipeline

After Pipeline

AppUser.php

<?php


class AppUser extends Authenticatable
{
    use Filterable;
    
}

AppUserRepository.php

<?php

....


public function getData()
{
    AppUser::filter([
        MobilePhoneFilter::class,
        '\App\Models\Filters\OtherFilter:created_at' // if want to pass attribute to the third params like middleware do
    ])->get();
}


....

BaseFilter.php

<?php

class BaseFilter
{
    private $request;

    public function __construct($request = null)
    {
        $this->request = json_decode(json_encode($request)) ?? request();
    }

    public function getRequest()
    {
        return $this->request;
    }
}

Filterable.php

<?php

use Illuminate\Pipeline\Pipeline;

trait Filterable
{
    public function scopeFilter($query, array $through)
    {
        return app(Pipeline::class)
            ->send($query)
            ->through($through)
            ->thenReturn();
    }
}

MobilePhoneFilter.php

<?php

class MobilePhoneFilter extends BaseFilter
{
    public function handle($query, $next)
    {
        $request = $this->getRequest();

        if (isset($request->mobile_phone)) {
            $query->where('mobile_phone',  'LIKE', "%$request->mobile_phone%");
        }

        return $next($query);
    }
}