扫码一下
查看教程更方便
教程 > laravel 教程 >
阅读：20
eloquent 序列化——迹忆客-ag捕鱼王app官网
简介
当构建 json api 时，经常需要转化模型和关联关系为数组或 json。eloquent 提供了便捷方法以便实现这些转换，以及控制哪些属性被包含到序列化中。
序列化模型 & 集合
序列化为数组
要转化模型及其加载的关联关系为数组，可以使用 toarray 方法。这个方法是递归的，所以所有属性及其关联对象属性（包括关联的关联）都会被转化为数组：
$user = app\user::with('roles')->first();
return $user->toarray();
如果只是将模型的属性转化为数组，可以使用 attributestoarray 方法：
$user = app\user::first();
return $user->attributestoarray();
还可以转化整个模型集合为数组：
$users = app\user::all();
return $users->toarray();
序列化为 json
要转化模型为 json，可以使用 tojson 方法，和 toarray 一样，tojson 方法也是递归的，所有属性及其关联属性都会被转化为 json。还可以指定 php 支持的 json 编码选项：
$user = app\user::find(1);
return $user->tojson();
return $user->tojson(json_pretty_print);
我们还可以转化模型或集合为字符串，这将会自动调用 tojson 方法：
$user = app\user::find(1);
return (string) $user;
由于模型和集合在转化为字符串的时候会被转化为 json，我们可以从应用的路由或控制器中直接返回 eloquent 对象：
route::get('users',function(){
return app\user::all();
});
关联关系
当一个 eloquent 模型被转化为 json 格式时，其加载的关联关系将自动以属性形式包含到 json 对象上。此外，尽管 eloquent 关联关系方法以“camel case” 定义，关联关系的 json 属性依然是“snake case”。
在 json 中隐藏属性
有时候我们希望在模型数组或 json 显示中隐藏某些属性，比如密码，要实现这个功能，在定义模型的时候设置 $hidden 属性：
注：如果要隐藏关联关系，使用关联关系的方法名，而不是动态属性名。
此外，可以使用 $visible 属性来定义模型数组和 json 显示的属性白名单。当模型被转化为数组或 json 时所有其它属性都会隐藏：
临时暴露隐藏属性
如果我们想要在特定模型中临时显示隐藏的属性，可以使用 makevisible 方法，该方法以方法链的调用方式返回模型实例：
return $user->makevisible('attribute')->toarray();
类似的，如果我们想要隐藏给定模型实例上某些显示的属性，可以使用 makehidden 方法：
return $user->makehidden('attribute')->toarray();
追加值到 json
有时候，转化模型为数组或 json 时，需要添加数据库中没有的字段到数组中，要实现这个功能，首先要为这个值定义一个访问器：
attributes['admin'] === 'yes';
}
}
定义好访问器后，添加字段名到该模型的 appends 属性。需要注意的是，尽管访问器使用“camel case”定义，属性名通常以“snake case”被引用：
字段被添加到 appends 列表之后，将会被包含到模型数组和 json 中，appends 数组中的属性还会遵循模型中配置的 visible 和 hidden 设置。
运行时追加
我们可以在单个模型上使用 append 方法来追加属性，或者，你可以使用 setappends 方法为给定模型覆盖整个追加属性数组：
return $user->append('is_admin')->toarray();
return $user->setappends(['is_admin'])->toarray();
日期序列化
自定义默认日期格式
我们可以通过重写 serializedate 方法自定义默认的日期序列化格式：
/**
* prepare a date for array / json serialization.
*
* @param \datetimeinterface $date
* @return string
*/
protected function serializedate(datetimeinterface $date)
{
return $date->format('y-m-d');
}
自定义每个属性的的日期格式
我们可以通过指定转化声明中的日期格式来自定义单个 eloquent 日期属性的序列化格式：
protected $casts = [
'birthday' => 'date:y-m-d',
'joined_at' => 'datetime:y-m-d h:00',
];
查看笔记
