Laravel Eloquent如何使用查询作用域_可复用的查询逻辑封装

// app/Models/User.php  namespace AppModels;  use IlluminateDatabaseEloquentFactoriesHasFactory; use IlluminateFoundationAuthUser as Authenticatable; use IlluminateNotificationsNotifiable;  class User extends Authenticatable {     use HasFactory, Notifiable;      // ... 其他属性和方法 ...      /**      * 查询所有活跃用户。      */     public function scopeActive($query)     {         return $query->where('is_active', true);     }      /**      * 查询指定角色的用户。      */     public function scopeRole($query, $role)     {         return $query->where('role', $role);     }      /**      * 查询指定创建时间范围内的用户。      */     public function scopeCreatedBetween($query, $from, $to)     {         return $query->whereBetween('created_at', [$from, $to]);     } }

// 获取所有活跃用户 $activeUsers = User::active()->get();  // 获取所有管理员用户 $admins = User::role('admin')->get();  // 获取在特定日期范围内创建的活跃编辑 $editors = User::active()                 ->role('editor')                 ->createdBetween('2023-01-01', '2023-12-31')                 ->get();  // 作用域可以链式调用，非常灵活 $recentActiveAdmins = User::active()->role('admin')->latest()->get();

// app/Scopes/ActiveUserScope.php  namespace AppScopes;  use IlluminateDatabaseEloquentBuilder; use IlluminateDatabaseEloquentModel; use IlluminateDatabaseEloquentScope;  class ActiveUserScope implements Scope {     /**      * 将作用域应用于给定的 Eloquent 查询构建器。      *      * @param  IlluminateDatabaseEloquentBuilder  $builder      * @param  IlluminateDatabaseEloquentModel  $model      * @return void      */     public function apply(Builder $builder, Model $model)     {         $builder->where('is_active', true);     } }

// app/Models/User.php  namespace AppModels;  use AppScopesActiveUserScope; // 引入全局作用域类 use IlluminateDatabaseEloquentFactoriesHasFactory; use IlluminateFoundationAuthUser as Authenticatable; use IlluminateNotificationsNotifiable;  class User extends Authenticatable {     use HasFactory, Notifiable;      // ... 其他属性和方法 ...      /**      * 模型“启动”时执行的任何引导逻辑。      *      * @return void      */     protected static function boot()     {         parent::boot();          static::addGlobalScope(new ActiveUserScope);     } }

// 这会获取所有 is_active 为 true 的用户 $users = User::all();  // 这也会获取所有 is_active 为 true 的用户，即使你没有显式调用 active() $admins = User::where('role', 'admin')->get();

// 获取所有用户，包括 is_active 为 false 的用户 $allUsers = User::withoutGlobalScope(ActiveUserScope::class)->get();  // 移除所有全局作用域 $allUsersIncludingInactiveAndDeleted = User::withoutGlobalScopes()->get();

蓝心千询

蓝心千询是vivo推出的一个多功能AI智能助手

34

查看详情

// 假设有一个商品列表，需要根据多种条件过滤 public function index(Request $request) {     $products = Product::query();      // 根据分类ID过滤 (本地作用域)     if ($request->has('category_id')) {         $products->byCategory($request->category_id);     }      // 根据状态过滤 (本地作用域)     if ($request->has('status')) {         $products->status($request->status);     }      // 根据价格范围过滤 (本地作用域)     if ($request->has('min_price') && $request->has('max_price')) {         $products->priceRange($request->min_price, $request->max_price);     }      // 默认只显示有库存的 (全局作用域，或另一个本地作用域)     // 假设 Product 模型有一个 scopeInStock()     $products->inStock();      // 排序     $products->orderBy('created_at', 'desc');      return $products->paginate(15); }

// app/Models/Post.php class Post extends Model {     // ...     public function scopePublished($query) { return $query->where('is_published', true); }     public function scopeFeatured($query) { return $query->where('is_featured', true); }     public function scopeOfType($query, $type) { return $query->where('type', $type); } }  // 在控制器或服务层中 public function getFilteredPosts(Request $request) {     $posts = Post::query()         ->when($request->has('type'), function ($query) use ($request) {             // 如果请求中包含 'type' 参数，则应用 ofType 作用域             $query->ofType($request->type);         })         ->when($request->boolean('show_featured'), function ($query) {             // 如果请求中 'show_featured' 为 true，则应用 featured 作用域             $query->featured();         })         ->when($request->boolean('show_published', true), function ($query) {             // 默认显示已发布的，除非明确指定不显示             $query->published();         })         ->get();      return $posts; }

// app/Repositories/PostRepository.php class PostRepository {     public function getPublishedPostsByType(string $type)     {         return Post::published()->ofType($type)->get();     }      public function getFeaturedPostsForAdmin()     {         // 假设有一个全局作用域用于管理员可见的帖子，或者在这里显式调用一个本地作用域         return Post::featured()->get();     } }  // 在服务层或控制器中 $posts = $postRepository->getPublishedPostsByType('article');