README

This package contains a collection of class that can be used with Laravel Pipeline.

Can do the same as the package pipeline-query-collection however the syntax differs, and gives the user a little more possibilities.

Allows you to implement conditionals for joins and add where clauses if certain data was passed.

Installation

You can install the package via composer:

composer require crazynds/query-pipeline

Usage

See the example below:

use Crazynds\QueryPipeline\Middleware\ILIKEQuery;
use Crazynds\QueryPipeline\Middleware\JoinQuery;
use Crazynds\QueryPipeline\QueryPipeline;

class ClientController extends Controller
{
    use QueryPipeline;

    public function index(Request $request){
        $page = $request->input('page', 1);
        $qtd = $request->input('qtd', 20);
        $query = Client::query();
        $data = $request->all();
        $query = $this->runPipeline($query,$data,[
            JoinQuery::class => [
                //table to join
                'addresses' => [
                    'on' => [ // required
                        'clients.address_id',
                        '=',
                        'addresses.id',
                    ],
                    'checkParameters'=>[ // optional, if any items from this array exist in the data keys, the join will be added to the query
                        // if not passed checkParameters, the join will be added in any condition
                        'country',
                        'state',
                        'city',
                    ],
                ]
            ],
            ILIKEQuery::class => [
                //table name
                'clients'=>[
                    //columns
                    'name',
                    'code',
                    'email',
                ],
                'addresses'=>[
                    'country',
                    'state',
                    'city',
                ]
            ],
        ]);
        return $query->paginate($qtd);
    }
}

Steps

First add the trait QueryPipeline from Crazynds\QueryPipeline\QueryPipeline to your class.
Setup your middleware stack variable
Send the base query, your data values and your stack to $this->runPipeline and the query pipeline will run.
Be happy :>

Middlewares

A middleware in this context means a step in which the query will be processed. See all the middlewares in folder src/middleware.

Each middleware has your stack of parameters, see below the specifications:

Join Query

The join query middleware add a join query based on conditions passed as parameters. Each join query can include multiples joins.

The base object recived by each iten in array is represented below:

<?php

$middlewareStack = [
    JoinQuery::class => [
        //table to join
        'table' => [
            'on' => [ // required
                'table.foreign_id',
                '=',
                'othertable.id',
            ],
            'checkParameters'=>[ 
            ],
        ]
    ]
];

The on array is limited to only simple verification, without multiple wheres. Because of this, the array recive only 3 parameter, the left column, the comparator, and the right column.

The checkParameters array, if not defined, the join will be added to query every time. If defined, the join will only be added to array if any of the string in the array is a key of array data;

ILIKE Query

The ilike query middleware add a where in the query with a comparation of type LIKE no case sensitive. The query add automatically the % in the start and end the string in the value.

The base object recived by each iten in array is represented below:

<?php

$middlewareStack = [
    ILIKEQuery::class => [
        //table name
        'clients'=>[
            'name', // this iten will check clients.name ilike %.$data['name'].%
            'code' => 'ssn', // this iten will check clients.name ilike %.$data['ssn'].%
            'email',
        ],
    ],
];

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

Crazynds

License

The MIT License (MIT). Please see License File for more information.

crazynds / query-pipeline

Maintainers

Details