Laravel Query Filter Builder: Build queries with parameters to define conditions

Recommend this page to a friend!
  Info   View files Documentation   View files View files (16)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2020-09-14 (1 month ago) RSS 2.0 feedNot yet rated by the usersTotal: 29 This week: 1All time: 10,020 This week: 232Up
Version License PHP version Categories
queryfilter 1.0.0Custom (specified...7PHP 5, Databases, Design Patterns
Description Author

This package can be used to build queries with parameters to define conditions.

It provides a trait that can be used with Laravel model classes to define queries that can be used to store and retrieve database records with the information for model objects that match certain conditions.

The package also provides a base filter class that can be extended by applications to implement specific query filter conditions.

The filter classes can be used from controller classes to store and retrieve the objects that the applications need to manipulate.

Picture of Hashemi Rafsan
  Performance   Level  
Name: Hashemi Rafsan <contact>
Classes: 4 packages by
Country: Bangladesh Bangladesh
Age: 24
All time rank: 416451 in Bangladesh Bangladesh
Week rank: 22 Up1 in Bangladesh Bangladesh Up
Innovation award
Innovation award
Nominee: 1x

Details

Laravel QueryFilter

A simple & dynamic package for your eloquent query in laravel. It will help you to write query logic individual for each parameter.

Installation

You can start it from composer. Go to your terminal and run this command from your project root directory.

composer require hashemi/queryfilter

  • If you're using Laravel, then Laravel will automatically discover the package. In case it doesn't discover the package then add the following provider in your `config/app.php`'s providers array.
    Hashemi\QueryFilter\QueryFilterServiceProvider::class
    
  • If you're using Lumen, then you'll have to add the following snippet in your `bootstrap/app.php` file.
    $app->register(Hashemi\QueryFilter\QueryFilterServiceProvider::class)
    

Usage

Suppose you want use query-filters on User model for query. Laravel QueryFilter provide Filterable trait . You need to use it on your model. It will add a scope filter on your model. Like,

class User extends Model
{
    // Use Filterable Trait
    // ....
    use \Hashemi\QueryFilter\Filterable;
    // ....
}

Now, you need to create your query filter file where you will write sql logic to generate sql by passing parameter. You can create your filter file by using command,

php artisan make:filter UserFilter

This command will create Filters directory on your app/ directory. So, you can find the file on app/Filters/UserFilter.php. Every method of filter class, represent your passing parameter key. You need to pass your parameter snake case and your method name will be like apply<ParamterName>Property format. Property name must be write in Pascal case.

class UserFilter extends \Hashemi\QueryFilter\QueryFilter
{
    public function applyIdProperty($id)
    {
        return $this->builder->where('id', '=', $id);
    }

    public function applyNameProperty($name)
    {
        return $this->builder->where('name', 'LIKE', "%$name%");
    }
}

After create that file, when you use your model on you controller to query something, you need to use your scope and pass UserFilter class as a parameter. You controller will be look like,

class UserController extends Controller
{
    public function index(Request $request, UserFilter $filter)
    {
        $user = User::query()->filter($filter)->get();
        // do whatever
    }
}

If you want to pass your custom queries on filter, you can also do that in your filter,

class UserController extends Controller
{
    public function index(Request $request, UserFilter $filter)
    {
        $user = User::query()->filter($filter, [
            'username' => 'ssi-anik'
        ])->get();
        // do whatever
    }
}

And on your app\Filters\UserFilter.php file, you can do something like it,

class UserFilter extends \Hashemi\QueryFilter\QueryFilter
{
    public function applyIdProperty($id)
    {
        return $this->builder->where('id', '=', $id);
    }

    public function applyNameProperty($name)
    {
        return $this->builder->where('name', 'LIKE', "%$name%");
    }
    
    public function applyUsernameProperty($username)
    {
        return $this->builder->where('username', 'LIKE', "%$username%");    
    }

}

That's it.

Convention

  • Your `Filterclass should have methods inapplyProperty` format. Where the `*` will be replaced by the StudlyCase Property names. So, if your field name is `first_name`, then the method name should be `applyFirstNameProperty()`.
  • If you're passing an extra data to the Model's filter scope like `Model::filter($filter, ['id' => 4])`, then the provided array will take precedence over the request's data.

Caveat

If your request & provided array to the filter scope cannot find any suitable method, then it'll return the whole table data as select * from your_table. Be aware of this issue.

Contributing

Pull requests are welcome. For any changes, please open an issue first to discuss what you would like to change.

  Files folder image Files  
File Role Description
Files folder imageexamples (3 files)
Files folder imagesrc (4 files, 1 directory)
Files folder imagetests (1 file, 2 directories)
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file phpunit.xml Data Auxiliary data
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  examples  
File Role Description
  Plain text file User.php Class Class source
  Plain text file UserController.php Class Class source
  Plain text file UserFilter.php Class Class source

  Files folder image Files  /  src  
File Role Description
Files folder imagestubs (1 file)
  Plain text file Filterable.php Class Class source
  Plain text file QueryFilter.php Class Class source
  Plain text file QueryFilterGenerateCommand.php Class Class source
  Plain text file QueryFilterServiceProvider.php Class Class source

  Files folder image Files  /  src  /  stubs  
File Role Description
  Plain text file filter.stub Class Class source

  Files folder image Files  /  tests  
File Role Description
Files folder imageHelpers (2 files)
Files folder imageQueryFilter (1 file)
  Accessible without login Plain text file bootstrap.php Example Example script

  Files folder image Files  /  tests  /  Helpers  
File Role Description
  Plain text file Dummy.php Class Class source
  Plain text file DummyFilter.php Class Class source

  Files folder image Files  /  tests  /  QueryFilter  
File Role Description
  Plain text file QueryFilterTest.php Class Class source

 Version Control Unique User Downloads Download Rankings  
 100%
Total:29
This week:1
All time:10,020
This week:232Up

For more information send a message to info at phpclasses dot org.