未加星标

[ Laravel 5.3 文档 ] Eloquent ORM ―― 序列化

字体大小 | |
[开发(php) 所属分类 开发(php) | 发布者 店小二05 | 时间 2016 | 作者 红领巾 ] 0人收藏点击收藏
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 属性:

<php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model{
/**
* 在数组中隐藏的属性
*
* @var array
*/
protected $hidden = ['password'];
}

注意:如果要隐藏关联关系,使用关联关系的方法名,而不是动态属性名。

此外,可以使用 visible 属性来定义模型数组和 JSON 显示的属性白名单:

<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model{
/**
* 在数组中显示的属性
*
* @var array
*/
protected $visible = ['first_name', 'last_name'];
}

临时暴露隐藏属性

如果你想要在特定模型中临时显示隐藏的属性,可以使用 makeVisible 方法,该方法以方法链的方式返回模型实例:

return $user->makeVisible('attribute')->toArray();

类似的,如果你想要隐藏给定模型实例上某些显示的属性,可以使用 makeHidden 方法:

return $user->makeHidden('attribute')->toArray(); 4、追加值到 JSON

有时候,需要添加数据库中没有的字段到数组中,要实现这个功能,首先要为这个值定义一个访问器:

<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model{
/**
* 为用户获取管理员标识
*
* @return bool
*/
public function getIsAdminAttribute()
{
return $this->attributes['admin'] == 'yes';
}
}

定义好访问器后,添加字段名到该模型的 appends 属性。需要注意的是,尽快访问器使用“camel case”形式定义,属性名通常以“snake case”的方式被引用:

<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model{
/**
* 追加到模型数组表单的访问器
*
* @var array
*/
protected $appends = ['is_admin'];
}

字段被添加到 appends 列表之后,将会被包含到模型数组和 JSON 中, appends 数组中的属性还会遵循模型中配置的 visible 和 hidden 设置。

本文开发(php)相关术语:php代码审计工具 php开发工程师 移动开发者大会 移动互联网开发 web开发工程师 软件开发流程 软件开发工程师

分页:12
转载请注明
本文标题:[ Laravel 5.3 文档 ] Eloquent ORM ―― 序列化
本站链接:http://www.codesec.net/view/480795.html
分享请点击:


1.凡CodeSecTeam转载的文章,均出自其它媒体或其他官网介绍,目的在于传递更多的信息,并不代表本站赞同其观点和其真实性负责;
2.转载的文章仅代表原创作者观点,与本站无关。其原创性以及文中陈述文字和内容未经本站证实,本站对该文以及其中全部或者部分内容、文字的真实性、完整性、及时性,不作出任何保证或承若;
3.如本站转载稿涉及版权等问题,请作者及时联系本站,我们会及时处理。
登录后可拥有收藏文章、关注作者等权限...
技术大类 技术大类 | 开发(php) | 评论(0) | 阅读(34)