laravel模型的scope前缀方法

最新推荐文章于 2024-10-19 16:45:44 发布

原创最新推荐文章于 2024-10-19 16:45:44 发布 · 1.8k 阅读

0 ·

CC 4.0 BY-SA版权

PHP 专栏收录该内容

42 篇文章

订阅专栏

本文介绍了 Laravel 模型中定义 `scope` 开头的方法，这类方法称为查询作用域，用于简化常见查询。通过在模型上定义带有 `scope` 前缀的方法，可以直接在模型上调用，无需在调用时包含前缀。示例包括无参数和带参数的 scope 方法定义，所有 scope 方法必须以 `scope` 开头，返回类型为 `Builder`，并且第一个参数应为 `Builder` 类型。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Laravel中模型中可以定义scope开头方法，这类方法可以通过模型直接调用。
这类方法也称作查询作用域

参考文档：https://laravel-china.org/docs/laravel/5.6/eloquent

例如，你可能经常需要获取「受欢迎的」用户。要定义这样一个范围，只需要在对应的 Eloquent 模型方法前加入 scope 前缀。scope方法总是返回一个查询构造器实例。

1.定义scope方法

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 只查询受欢迎的用户.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopePopular($query)
    {
        return $query->where('votes', '>', 100);
    }

    /**
     * 只查询 active 的用户.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeActive($query)
    {
        return $query->where('active', 1);
    }
}

2.调用scope方法：
在方法调用时你不需要添加 scope 前缀

$users = App\User::popular()->active()->orderBy('created_at')->get();

有时，你可能希望定义一个可接受参数的范围。
这时只需给你的范围添加额外的参数即可。
范围参数应该定义在 $query 参数后。

    public function scopeOfType($query, $type)
    {
        return $query->where('type', $type);
    }

注意事项：

方法定义必须以scope开头。后面第一个字母大写。后面括号中第一个必须是Builder,第二个参数可以根据需要定义。
方法返回值也必须是Builder