[ Laravel 5.2 文档 ] Eloquent ORM -- 序列化
1、简介
当构建JSONAPI 时,经常需要转化模型和关联关系为数组或 JSON。Eloquent 包含便捷方法实现这些转换,以及控制哪些属性被包含到序列化中。
2、基本使用
转化模型为数组
要转化模型及其加载的关联关系为数组,可以使用 toArray方法。这个方法是递归的,所以所有属性及其关联对象属性(包括关联的关联)都会被转化为数组:
$user = App\User::with('roles')->first();return $user->toArray();
还可以转化集合为数组:
$users = App\User::all();return $users->toArray();
转化模型为 JSON
要转化模型为 JSON,可以使用 toJson方法,和 toArray一样, toJson方法也是递归的,所有属性及其关联属性都会被转化为 JSON:
$user = App\User::find(1);return $user->toJson();
你还可以转化模型或集合为字符串,这将会自动调用 toJson方法:
$user = App\User::find(1);return (string) $user;
由于模型和集合在转化为字符串的时候会被转化为 JSON,你可以从应用的路由或控制器中直接返回 Eloquent 对象:
Route::get('users',function(){ return App\User::all();});
3、在 JSON 中隐藏属性
有时候你希望在模型数组或 JSON 显示中隐藏某些属性,比如密码,要实现这个,在定义模型的时候设置 $hidden属性:
注意:如果要隐藏关联关系,使用关联关系的方法名,而不是动态属性名。
此外,可以使用 visible属性来定义模型数组和 JSON 显示的属性白名单:
临时暴露隐藏属性
如果你想要在特定模型中临时显示隐藏的属性,可以使用 makeVisible方法,该方法以方法链的方式返回模型实例:
return $user->makeVisible('attribute')->toArray();4、追加值到 JSON
有时候,需要添加数据库中没有的字段到数组中,要实现这个功能,首先要为这个值定义一个访问器:
attributes['admin'] == 'yes'; }}定义好访问器后,添加字段名到该模型的 appends属性:
字段被添加到 appends列表之后,将会被包含到模型数组和 JSON 中, appends数组中的字段还会遵循模型中配置的 visible和 hidden设置。
下一篇: 发送mime邮件类--实例_PHP
推荐阅读
-
[ Laravel 5.2 文档 ] Eloquent ORM -- 序列化
-
Laravel 5框架学习之Eloquent (laravel 的ORM)_php实例
-
[ Laravel 5.2 文档 ] 服务 -- Redis
-
Laravel 5框架学习之Eloquent (laravel 的ORM)_PHP
-
[ Laravel 5.2 文档 ] 服务 -- 分页
-
[ Laravel 5.2 文档 ] 架构 -- 门面(Facades)
-
在Laravel 5.2中,如果使用DB门面代替Eloquent ORM,性能会提高多少?
-
[ Laravel 5.2 文档 ] 服务 -- 包开发
-
[ Laravel 5.2 文档 ] 数据库 -- 填充数据
-
Laravel 5框架学习之Eloquent (laravel 的ORM)