Laravel日常笔记系列之二

• 全局作用域
  • 编写全局作用域
  • 应用全局作用域
    • 生成测试数据
    • 测试全局作用域
  • 匿名的全局作用域
  • 删除全局作用域
• 本地作用域
  • 使用本地作用域
  • 动态作用域

全局作用域

全局范围能为给定模型的所有查询添加约束。Laravel 自带的 软删除功能 就利用全局作用域从数据库中提取「未删除」的模型。编写自定义的全局作用域可以提供一个方便、简单的方法来确保给定模型的每个查询都受到一定的约束。

编写全局作用域

编写全局作用域很简单。首先定义一个实现 Illuminate\Database\Eloquent\Scope 接口的类。这个接口要求你实现一个方法：apply。apply 方法可以根据需要添加 where 条件到查询：

<?php
/**
 * Created by PhpStorm.
 * User: zhanglingyu
 * Date: 2019-03-08
 * Time: 13:09
 */
namespace App\Scopes;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Scope;

class IdScope implements Scope
{

    /**
     * Apply the scope to a given Eloquent query builder.
     *
     * @param  \Illuminate\Database\Eloquent\Builder $builder
     * @param  \Illuminate\Database\Eloquent\Model $model
     * @return void
     */
    public function apply(Builder $builder, Model $model)
    {[](http://)
        // TODO: Implement apply() method.
        return $builder->where('id', '>', 5);
    }
}

这里定义一个ID的作用域，只选择ID大于5的数据。

应用全局作用域

要将全局作用域分配给模型，需要重写给定模型的 boot 方法并使用 addGlobalScope 方法：

生成测试数据

使用模型工厂生成10条测试数据。在php artisan tinker中执行 factory(App\User::class,10)->create();

测试全局作用域

重新启动tinker, 在命令行中执行User::all('id'),结果中可看出只返回了ID大于5的数据:

匿名的全局作用域

Eloquent 还能使用闭包定义全局作用域，如此一来，便就没必要定义一个单独的类了： 再次在tinker中测试输出：

删除全局作用域

如果要删除给定的查询的全局作用域，则可以使用 withoutGlobalScope 方法。该方法接受全局作用域的类名作为其唯一参数：

User::withoutGlobalScope(IDScope::class)->get(); # 指定类
User::withoutGlobalScope('last_id')->get();   # 匿名函数
User::withoutGlobalScopes()->get();  # 移除所有全局作用域
User::withoutGlobalScopes([FirstScope::class, SecondScope::class])->get();   # 移除多个类/匿名函数

本地作用域

本地作用域能定义通用的约束集合以便在应用中复用。例如，你现在需要选择最后一个用户，为此要定义一个作用域，只需要在 scope 前加上一个 Eloquent 模型方法即可。

作用域应始终返回查询生成器实例：

使用本地作用域

在tinker中执行User::lastOne()->get(); ,得到如下结果： 注意，在调用方法时，不应包含 scope 前缀。你甚至可以链式调用到多个不同的 scope

动态作用域

只需将附加参数添加到作用域。作用域参数应该在 $query 参数之后定义： 在tinker中执行User::findId(5)->get(); ,得到如下结果：

==================================
由于本人水平有限，文章在表述和代码方面如有不妥之处，欢迎批评指正。