All Projects → hashemirafsan → Queryfilter

hashemirafsan / Queryfilter

Licence: mit
Laravel queryfilter is a simple & dynamic package for your eloquent query in laravel. It will help you to write query logic individual for each parameter.

Projects that are alternatives of or similar to Queryfilter

Bounty
Javascript and SVG odometer effect library with motion blur
Stars: ✭ 724 (+2485.71%)
Mutual labels:  filters
Simple Cache
An easy to use Caching trait for Laravel's Eloquent Models.
Stars: ✭ 19 (-32.14%)
Mutual labels:  laravel-package
Laravel Mailguneu
Allow customising the Mailgun server URL to use EU servers.
Stars: ✭ 13 (-53.57%)
Mutual labels:  laravel-package
Twitter
Twitter API for Laravel 5.5+, 6.x, 7.x & 8.x
Stars: ✭ 755 (+2596.43%)
Mutual labels:  laravel-package
Package Skeleton
📦 My base for PHP packages.
Stars: ✭ 6 (-78.57%)
Mutual labels:  laravel-package
Ewma
Exponentially Weighted Moving Average Filter
Stars: ✭ 21 (-25%)
Mutual labels:  filters
Chat
A Laravel chat package. You can use this package to create a chat/messaging Laravel application.
Stars: ✭ 710 (+2435.71%)
Mutual labels:  laravel-package
Pornlist
Ad-blocking porn websites filter list for Adblock Plus and uBlock Origin.
Stars: ✭ 21 (-25%)
Mutual labels:  filters
Laravel Log
Simple API to write logs for Laravel.
Stars: ✭ 19 (-32.14%)
Mutual labels:  laravel-package
Blade Migrations Laravel
An intelligent alternative version of Laravel 5/6 Database Migrations - uses raw-sql syntax, transactions, auto-rollback, UP-DOWN-UP testing
Stars: ✭ 25 (-10.71%)
Mutual labels:  laravel-package
Laravel Notify
Flexible Flash notifications for Laravel
Stars: ✭ 787 (+2710.71%)
Mutual labels:  laravel-package
Laravel Blade Directives
A collection of nice Laravel Blade directives
Stars: ✭ 813 (+2803.57%)
Mutual labels:  laravel-package
Laravel Aws Sns
Laravel package for the AWS SNS Events
Stars: ✭ 24 (-14.29%)
Mutual labels:  laravel-package
Laravel User Verification
PHP package built for Laravel 5.* to easily handle a user email verification and validate the email
Stars: ✭ 755 (+2596.43%)
Mutual labels:  laravel-package
Vue2 Filters
A collection of Vue.js filters
Stars: ✭ 886 (+3064.29%)
Mutual labels:  filters
Orm
A drop-in Doctrine ORM 2 implementation for Laravel 5+ and Lumen
Stars: ✭ 712 (+2442.86%)
Mutual labels:  laravel-package
Eloquent Ldap
A Laravel 5.1 package that first tries to log the user against the internal database if that fails, it tries against the configured LDAP/AD server.
Stars: ✭ 19 (-32.14%)
Mutual labels:  laravel-package
Doorman
Limit access to your Laravel applications by using invite codes
Stars: ✭ 913 (+3160.71%)
Mutual labels:  laravel-package
Chatify
A Laravel package that allows you to add a complete user messaging system into your new/existing Laravel application.
Stars: ✭ 885 (+3060.71%)
Mutual labels:  laravel-package
Search Ui
🔍 A set of UI components to build a fully customized search!
Stars: ✭ 24 (-14.29%)
Mutual labels:  filters

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 *Filter class should have methods in apply*Property 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.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].