本教程详细阐述了在laravel应用中，如何动态地显示eloquent模型中被标记为`$hidden`的属性，尤其是在使用查询构建器进行数据分页后。我们将探讨`makevisible()`方法的正确使用时机，确保特定属性在需要时能够被前端或其他服务访问，同时维护模型的默认数据隐私设置。
引言：Laravel模型的隐藏属性
在Laravel的Eloquent ORM中，模型（Model）提供了一个强大的特性，即通过$hidden属性来控制哪些模型属性在序列化为数组或JSON时默认不被包含。这对于保护敏感数据（如密码、API密钥、内部标识符等）至关重要，防止它们在不经意间暴露给客户端或日志。
例如，一个Hoster模型可能包含以下隐藏属性：
// app/Models/Hoster.phpclass Hoster extends Model{ // ... 其他属性和方法 /** * 应隐藏的属性。 * * @var array */ protected $hidden = [ 'past_works', 'anchor', 'contact_number', 'email' ]; // ...}
这意味着当Hoster模型实例被转换为数组或JSON时，past_works、anchor、contact_number和email这些字段将不会被包含在输出中。
问题：Query Builder与makeVisible()的困境
在某些业务场景下，我们可能需要在特定路由或条件下，临时性地显示这些通常被隐藏的属性。Laravel为此提供了makeVisible()方法。然而，一个常见的误区是尝试直接在Eloquent查询构建器（Query Builder）实例上调用此方法，尤其是在使用paginate()进行分页时：
// 错误的尝试$hosters = Hoster::query() // ... 其他查询条件 ->makeVisible(['contact_number']) // 这里调用是无效的 ->paginate(8);
这种做法是无效的，因为makeVisible()方法是Eloquent模型实例或Eloquent集合（Collection）的方法，而不是IlluminateDatabaseEloquentBuilder（即查询构建器）的方法。查询构建器负责构造并执行数据库查询，它返回的是原始数据或一个包含模型实例的集合，而非模型实例本身或集合对象。
解决方案：在分页结果上应用makeVisible()
正确的做法是，在查询构建器执行完查询并返回模型集合（或分页器）之后，再对结果应用makeVisible()方法。当使用paginate()方法时，它会返回一个LengthAwarePaginator实例，这个实例内部包含了一个Eloquent模型集合。我们可以直接在这个分页器实例上调用makeVisible()，它会自动遍历其中的每个模型并应用可见性更改。
以下是具体的实现步骤和代码示例：
1. 模型定义
确保你的模型中定义了需要隐藏的属性。
// app/Models/Hoster.phpnamespace AppModels;use IlluminateDatabaseEloquentModel;class Hoster extends Model{ // ... protected $fillable = [ 'name', 'is_approved' // 示例可填充字段 ]; protected $hidden = [ 'past_works', 'anchor', 'contact_number', 'email' ]; // ...}
2. 控制器中的正确用法
在你的控制器方法中，首先使用查询构建器完成数据的筛选、排序和分页操作。然后，在paginate()方法返回LengthAwarePaginator实例之后，调用其上的makeVisible()方法，传入你希望显示的所有属性名称。
// app/Http/Controllers/HosterController.phpnamespace AppHttpControllers;use AppModelsHoster;use IlluminateHttpRequest;use InertiaInertia; // 假设使用 Inertia.jsclass HosterController extends Controller{ public function show(Request $request) { $hosters = Hoster::query() ->when($request->input('search'), function ($query, $search) { if ($search === "approved") { return $query->where('is_approved', '=', true); } elseif ($search === "notapproved") { return $query->where('is_approved', '=', false); } return $query ->where('name', 'like', '%' . $search . '%') ->orWhere('contact_number', 'like', '%' . $search . '%') ->orWhere('email', 'like', '%' . $search . '%'); }) ->orderBy('created_at', 'desc') ->paginate(8) ->withQueryString(); // 保持分页链接的查询字符串 // 关键步骤：在分页结果（LengthAwarePaginator实例）上调用 makeVisible() // 这将使分页器中每个 Hoster 模型实例的 'past_works', 'contact_number', 'email' 属性可见 $hosters->makeVisible([ 'past_works', 'contact_number', 'email' ]); return Inertia::render('Hoster/Show', [ 'hosters' => $hosters, 'filters' => $request->only(['search']), ]); }}
通过以上修改，当$hosters变量被序列化并传递到前端（例如通过Inertia.js）时，past_works、contact_number和email字段将包含在每个Hoster对象的JSON表示中。
makeVisible()方法详解
makeVisible()方法是Eloquent模型和集合（包括LengthAwarePaginator包装的集合）提供的一个实用功能。
作用：它用于动态地覆盖模型实例或集合的$hidden设置，使其指定的属性在序列化时变得可见。参数：接受一个字符串（单个属性名）或一个字符串数组（多个属性名）。返回：对于模型实例，它返回模型实例本身；对于集合或分页器，它返回修改后的集合或分页器实例，其中包含的模型实例已更新了可见性设置。原理：当对集合或分页器调用makeVisible()时，Laravel会遍历集合中的每一个模型，并对每个模型实例应用可见性更改。
注意事项
作用范围：makeVisible()只影响当前获取到的模型实例的序列化行为，它不会修改数据库中的数据，也不会更改模型的全局$hidden定义。这意味着在其他请求或上下文中使用相同的模型时，这些属性仍将是隐藏的，除非再次调用makeVisible()。性能考量：makeVisible()操作是在内存中对已加载的模型数据进行处理，因此通常不会对数据库查询性能产生显著影响。安全与隐私：虽然makeVisible()提供了灵活性，但在决定显示隐藏属性时务必谨慎。只在确实需要且确保数据安全的前提下才暴露敏感信息。与makeHidden()结合：与makeVisible()相对的是makeHidden()方法，它可以用于动态隐藏模型中默认可见的属性。这两个方法结合使用，可以实现对模型属性可见性的精细控制。
总结
在Laravel中，动态控制Eloquent模型属性的可见性是一项常见需求。通过理解makeVisible()方法的正确应用时机——即在查询构建器执行并返回模型实例或集合之后——我们可以有效地在特定场景下显示隐藏属性，例如在分页结果中。这种方法既保证了数据隐私的默认设置，又提供了根据业务需求灵活调整数据输出的能力，是构建健壮且安全Laravel应用的关键技巧之一。
以上就是Laravel Eloquent：在分页查询结果中动态显示模型隐藏属性的详细内容，更多请关注php中文网其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1336987.html
微信扫一扫 
支付宝扫一扫 
