Download the PHP package l3aro/pipeline-query-collection without Composer

A query database collection for use with Laravel Pipeline

This package contains a collection of class that can be used with Laravel Pipeline. Let's see below queries:

As you all can see, it's obviously that filter conditions will continue to grow as well as the duplication of same filter for other queries. We can use Laravel Pipeline combine with some pre-made queries to refactor this

Table of Contents

• A query database collection for use with Laravel Pipeline
• Table of Contents
• Installation
• Usage
  • Preparing your model
  • Feature
    • Bitwise filter
    • Boolean filter
    • Date From filter
    • Date To filter
    • Exact filter
    • Relation filter
    • Relative filter
    • Scope filter
    • Trash filter
    • Sort
  • Detector
  • Custom search column
  • Custom search value
  • Extend filter
• Testing
• Contributing
• Security Vulnerabilities
• Credits
• License

Installation

Install the package via composer:

Optionally, you can publish the config file with:

This is the contents of the published config file:

Usage

Preparing your model

To use this collection with a model, you should implement the following interface and trait:

After setup your model, you can use scope filter on your model like this

You can also override the predefined filter lists in your model like this

Feature

Here the use all filter and sort in the collection

Bitwise filter

Boolean filter

Date From filter

Date To filter

Exact filter

Relation filter

Relative filter

Scope filter

Trash filter

When using Laravel's soft delete, you can use the pipe TrashFilter to query these models. The default query name is trashed, and filters responds to particular values:

• with: the query should be ?trashed=with to include soft deleted records to the result set
• only: the query should be ?trashed=only to return only soft deleted records to the result set

• any other value, or completely remove trashed from request query will return only records that are not soft deleted in the result set

  You can change query name trashed by passing your custom name to the TrashFilter constructor

Sort

Detector

Sometimes, you want to setup your request with a prefix like filter.. You can config every pipe that have it

Or, you can define it globally

Custom search column

Sometimes, your request field is not the same with column name. For example, in your database you have column respond and want to perform some query against it, but for some reasons, your request query is reply instead of respond.

Custom search value

Your value that need to be searched isn't from your request? No problems. You can use value() function to hard set the search value!

Extend filter

Yeah, you are free to use your own pipe. Take a look at some of my filters. All of them extends BaseFilter to have some useful properties and functions.

Testing

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• l3aro
• All Contributors

License

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