标签：expec canonical elf 分享 follow local art intro spec
An Eloquent way to filter Eloquent Models and their relationships
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 App\Http\Controllers;
use Illuminate\Http\Request;
use App\Http\Requests;
use App\User;
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 App\Http\Controllers;
use Illuminate\Http\Request;
use App\Http\Requests;
use App\User;
class UserController extends Controller
{
public function index(Request $request)
{
return User::filter($request->all())->get();
}
}
composer require tucker-eric/eloquentfilter
There are a few ways to define the filter a model will use:
The default namespace for all filters is App\ModelFilters\ 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 |
|---|---|
App\User |
App\ModelFilters\UserFilter |
App\FrontEnd\PrivatePost |
App\ModelFilters\PrivatePostFilter |
App\FrontEnd\Public\GuestPost |
App\ModelFilters\GuestPostFilter |
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 EloquentFilter\ServiceProvider::class in your config/app.phpconfiguration file:
‘providers‘ => [
// Other service providers...
EloquentFilter\ServiceProvider::class,
],
Copy the package config to your local config with the publish command:
php artisan vendor:publish --provider="EloquentFilter\ServiceProvider"
In the config/eloquentfilter.php config file. Set the namespace your model filters will reside in:
‘namespace‘ => "App\\ModelFilters\\",
This is only required if you want to use the
php artisan model:filtercommand.
In bootstrap/app.php:
$app->register(EloquentFilter\LumenServiceProvider::class);
In bootstrap/app.php:
config([‘eloquentfilter.namespace‘ => "App\\Models\\ModelFilters\\"]);
Create a public method modelFilter() that returns $this->provideFilter(Your\Model\Filter::class); in your model.
<?php
namespace App;
use EloquentFilter\Filterable;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
use Filterable;
public function modelFilter()
{
return $this->provideFilter(App\ModelFilters\CustomFilters\CustomUserFilter::class);
}
//User Class
}
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 App\Http\Controllers;
use Illuminate\Http\Request;
use App\Http\Requests;
use App\User;
use App\ModelFilters\Admin\UserFilter as AdminFilter;
use App\ModelFilters\User\UserFilter 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();
}
}
Only available if you have registered
EloquentFilter\ServiceProvider::classin 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
Define the filter logic based on the camel cased input key passed to the filter() method.
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$this->input() method or a single value by key $this->input($key)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 EloquentFilter\ModelFilter;
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);
}
}
标签：expec canonical elf 分享 follow local art intro spec
原文地址：https://www.cnblogs.com/shine-c/p/9988494.html
