x'c'x

Posted 2021-01-21 shine-c

Eloquent Filter

     

An Eloquent way to filter Eloquent Models and their relationships

Introduction

Lets say we want to return a list of users filtered by multiple parameters. When we navigate to:

/users?name=er&last_name=&company_id=2&roles[]=1&roles[]=4&roles[]=7&industry=5

$request->all() will return:

[
    ‘name‘       => ‘er‘,
    ‘last_name‘  => ‘‘,
    ‘company_id‘ => ‘2‘,
    ‘roles‘      => [‘1‘,‘4‘,‘7‘],
    ‘industry‘   => ‘5‘
]

To filter by all those parameters we would need to do something like:

<?php

namespace AppHttpControllers;

use IlluminateHttpRequest;
use AppHttpRequests;
use AppUser;

class UserController extends Controller
{

    public function index(Request $request)
    {
        $query = User::where(‘company_id‘, $request->input(‘company_id‘));

        if ($request->has(‘last_name‘))
        {
            $query->where(‘last_name‘, ‘LIKE‘, ‘%‘ . $request->input(‘last_name‘) . ‘%‘);
        }

        if ($request->has(‘name‘))
        {
            $query->where(function ($q) use ($request)
            {
                return $q->where(‘first_name‘, ‘LIKE‘, $request->input(‘name‘) . ‘%‘)
                    ->orWhere(‘last_name‘, ‘LIKE‘, ‘%‘ . $request->input(‘name‘) . ‘%‘);
            });
        }

        $query->whereHas(‘roles‘, function ($q) use ($request)
        {
            return $q->whereIn(‘id‘, $request->input(‘roles‘));
        })
            ->whereHas(‘clients‘, function ($q) use ($request)
            {
                return $q->whereHas(‘industry_id‘, $request->input(‘industry‘));
            });

        return $query->get();
    }

}

To filter that same input With Eloquent Filters:

<?php

namespace AppHttpControllers;

use IlluminateHttpRequest;
use AppHttpRequests;
use AppUser;

class UserController extends Controller
{

    public function index(Request $request)
    {
        return User::filter($request->all())->get();
    }

}

Configuration

Install Through Composer

composer require tucker-eric/eloquentfilter

There are a few ways to define the filter a model will use:

• Use EloquentFilter‘s Default Settings
• Use A Custom Namespace For All Filters
• Define A Model‘s Default Filter
• Dynamically Select A Model‘s Filter

Default Settings

The default namespace for all filters is AppModelFilters and each Model expects the filter classname to follow the {$ModelName}Filter naming convention regardless of the namespace the model is in. Here is an example of Models and their respective filters based on the default naming convention.

Model	ModelFilter
AppUser	AppModelFiltersUserFilter
AppFrontEndPrivatePost	AppModelFiltersPrivatePostFilter
AppFrontEndPublicGuestPost	AppModelFiltersGuestPostFilter

Laravel

With Configuration File (Optional)

Registering the service provider will give you access to the php artisan model:filter {model} command as well as allow you to publish the configuration file. Registering the service provider is not required and only needed if you want to change the default namespace or use the artisan command

After installing the Eloquent Filter library, register the EloquentFilterServiceProvider::class in your config/app.phpconfiguration file:

‘providers‘ => [
    // Other service providers...

    EloquentFilterServiceProvider::class,
],

Copy the package config to your local config with the publish command:

php artisan vendor:publish --provider="EloquentFilterServiceProvider"

In the config/eloquentfilter.php config file. Set the namespace your model filters will reside in:

‘namespace‘ => "App\ModelFilters\",

Lumen

Register The Service Provider (Optional)

This is only required if you want to use the php artisan model:filter command.

In bootstrap/app.php:

$app->register(EloquentFilterLumenServiceProvider::class);

Change The Default Namespace

In bootstrap/app.php:

config([‘eloquentfilter.namespace‘ => "App\Models\ModelFilters\"]);

Define The Default Model Filter

Create a public method modelFilter() that returns $this->provideFilter(YourModelFilter::class); in your model.

<?php

namespace App;

use EloquentFilterFilterable;
use IlluminateDatabaseEloquentModel;

class User extends Model
{
    use Filterable;

    public function modelFilter()
    {
        return $this->provideFilter(AppModelFiltersCustomFiltersCustomUserFilter::class);
    }

    //User Class
}

Dynamic Filters

You can define the filter dynamically by passing the filter to use as the second parameter of the filter() method. Defining a filter dynamically will take precedent over any other filters defined for the model.

<?php

namespace AppHttpControllers;

use IlluminateHttpRequest;
use AppHttpRequests;
use AppUser;
use AppModelFiltersAdminUserFilter as AdminFilter;
use AppModelFiltersUserUserFilter as BasicUserFilter;
use Auth;

class UserController extends Controller
{
    public function index(Request $request)
    {
        $userFilter = Auth::user()->isAdmin() ? AdminFilter::class : BasicUserFilter::class;

        return User::filter($request->all(), $userFilter)->get();
    }
}

Generating The Filter

Only available if you have registered EloquentFilterServiceProvider::class in the providers array in your `config/app.php‘

You can create a model filter with the following artisan command:

php artisan model:filter User

Where User is the Eloquent Model you are creating the filter for. This will create app/ModelFilters/UserFilter.php

The command also supports psr-4 namespacing for creating filters. You just need to make sure you escape the backslashes in the class name. For example:

php artisan model:filter AdminFilters\User

This would create app/ModelFilters/AdminFilters/UserFilter.php

Usage

Defining The Filter Logic

Define the filter logic based on the camel cased input key passed to the filter() method.

• Empty strings are ignored
• setup() will be called regardless of input
• _id is dropped from the end of the input to define the method so filtering user_id would use the user() method
• Input without a corresponding filter method are ignored
• The value of the key is injected into the method
• All values are accessible through the $this->input() method or a single value by key $this->input($key)
• All Eloquent Builder methods are accessible in this context in the model filter class.

To define methods for the following input:

[
    ‘company_id‘   => 5,
    ‘name‘         => ‘Tuck‘,
    ‘mobile_phone‘ => ‘888555‘
]

You would use the following methods:

use EloquentFilterModelFilter;

class UserFilter extends ModelFilter
{
    protected $blacklist = [‘secretMethod‘];
    
    // This will filter ‘company_id‘ OR ‘company‘
    public function company($id)
    {
        return $this->where(‘company_id‘, $id);
    }

    public function name($name)
    {
        return $this->where(function($q) use ($name)
        {
            return $q->where(‘first_name‘, ‘LIKE‘, "%$name%")
                ->orWhere(‘last_name‘, ‘LIKE‘, "%$name%");
        });
    }

    public function mobilePhone($phone)
    {
        return $this->where(‘mobile_phone‘, ‘LIKE‘, "$phone%");
    }

    public function setup()
    {
        $this->onlyShowDeletedForAdmins();
    }

    public function onlyShowDeletedForAdmins()
    {
        if(Auth::user()->isAdmin())
        {
            $this->withTrashed();
        }
    }
    
    public function secretMethod($secretParameter)
    {
        return $this->where(‘some_column‘, true);
    }
}

以上是关于x'c'x的主要内容，如果未能解决你的问题，请参考以下文章

x'c'x

python里students.sort(key=lambda x: x['name'])，两个x的意思是啥？

Vivado hls 对C语言的限制需要改哪些怎么改代码

[react] Module not found: Can't resolve 'schedule' in 'C:Usersadcaldvmtn7myapp (代码片段

c语言的运算符号数组替代

c语言编程