[Laravel5.2文档]EloquentORM--序列化
内容导读
互联网集市收集整理的这篇技术教程文章主要介绍了[Laravel5.2文档]EloquentORM--序列化,小编现在分享给大家,供广大互联网技能从业者学习和参考。文章包含2558字,纯文字阅读大概需要4分钟。
内容图文
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属性:
<?phpnamespace App;use Illuminate\Database\Eloquent\Model;class User extends Model{ /** * 在数组中隐藏的属性 * * @var array */ protected $hidden = ['password'];}
注意:如果要隐藏关联关系,使用关联关系的方法名,而不是动态属性名。
此外,可以使用 visible属性来定义模型数组和 JSON 显示的属性白名单:
<?phpnamespace App;use Illuminate\Database\Eloquent\Model;class User extends Model{ /** * 在数组中显示的属性 * * @var array */ protected $visible = ['first_name', 'last_name'];}
临时暴露隐藏属性
如果你想要在特定模型中临时显示隐藏的属性,可以使用 makeVisible方法,该方法以方法链的方式返回模型实例:
return $user->makeVisible('attribute')->toArray();
4、追加值到 JSON
有时候,需要添加数据库中没有的字段到数组中,要实现这个功能,首先要为这个值定义一个访问器:
<?phpnamespace App;use Illuminate\Database\Eloquent\Model;class User extends Model{ /** * 为用户获取管理员标识 * * @return bool */ public function getIsAdminAttribute() { return $this->attributes['admin'] == 'yes'; }}
定义好访问器后,添加字段名到该模型的 appends属性:
<?phpnamespace App;use Illuminate\Database\Eloquent\Model;class User extends Model{ /** * 追加到模型数组表单的访问器 * * @var array */ protected $appends = ['is_admin'];}
字段被添加到 appends列表之后,将会被包含到模型数组和 JSON 中, appends数组中的字段还会遵循模型中配置的 visible和 hidden设置。
内容总结
以上是互联网集市为您收集整理的[Laravel5.2文档]EloquentORM--序列化全部内容,希望文章能够帮你解决[Laravel5.2文档]EloquentORM--序列化所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错,欢迎将互联网集市网站推荐给程序员好友。
内容备注
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 gblab@vip.qq.com 举报,一经查实,本站将立刻删除。
内容手机端
扫描二维码推送至手机访问。