# Eloquent ORM —— 序列化
## 1、简介
当构建JSON中。
## 2、基本使用
### 2.1 转化模型为数组
要转化模型及其加载的[关联关系](http://laravelacademy.org/post/140.html)为数组,可以使用`toArray`方法。这个方法是递归的,所以所有属性及其关联对象属性(包括关联的关联)都会被转化为数组:
~~~
$user = App\User::with('roles')->first();
return $user->toArray();
~~~
还可以转化[集合](http://laravelacademy.org/post/144.html)为数组:
~~~
$users = App\User::all();
return $users->toArray();
~~~
### 2.2 转化模型为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`属性定义属性显示的白名单:
~~~
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model{
/**
* 在数组中显示的属性
*
* @var array
*/
protected $visible = ['first_name', 'last_name'];
}
~~~
## 4、追加值到JSON
有时候,需要添加数据库中没有相应的字段到数组中,要实现这个,首先要定义一个[访问器](http://laravelacademy.org/post/146.html#ipt_kb_toc_146_2):
~~~
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model{
/**
* 为用户获取管理员标识
*
* @return bool
*/
public function getIsAdminAttribute()
{
return $this->attributes['admin'] == 'yes';
}
}
~~~
定义好访问器后,添加字段名到模型的`appends`属性:
~~~
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model{
/**
* 追加到模型数组表单的访问器
*
* @var array
*/
protected $appends = ['is_admin'];
}
~~~
字段被添加到`appends`列表之后,将会被包含到模型数组和JSON表单中,`appends`数组中的字段还会遵循模型中的`visible`和`hidden`设置配置。
- 前言
- 序言
- 序言 ―― 发行版本说明
- 序言 ―― 升级指南
- 序言 ―― 贡献代码
- 开始
- 开始 ―― 安装及配置
- 开始 ―― Laravel Homestead
- 基础
- 基础 ―― HTTP路由
- 基础 ―― HTTP 中间件
- 基础 ―― HTTP 控制器
- 基础 ―― HTTP 请求
- 基础 ―― HTTP 响应
- 基础 ―― 视图
- 基础 ―― Blade模板
- 架构
- 架构 ―― 一次请求的生命周期
- 架构 ―― 应用目录结构
- 架构 ―― 服务提供者
- 架构 ―― 服务容器
- 架构 ―― 契约
- 架构 ―― 门面
- 数据库
- 数据库 ―― 起步
- 数据库 ―― 查询构建器
- 数据库 ―― 迁移
- 数据库 ―― 填充数据
- Eloquent ORM
- Eloquent ORM ―― 起步
- Eloquent ORM ―― 关联关系
- Eloquent ORM ―― 集合
- Eloquent ORM ―― 调整器
- Eloquent ORM ―― 序列化
- 服务
- 服务 ―― 用户认证
- 服务 ―― Artisan 控制台
- 服务 ―― Laravel Cashier(交易)
- 服务 ―― 缓存
- 服务 ―― 集合
- 服务 ―― Laravel Elixir
- 服务 ―― 加密
- 服务 ―― 错误&日志
- 服务 ―― 事件
- 服务 ―― 文件系统/云存储
- 服务 ―― 哈希
- 服务 ―― 帮助函数
- 服务 ―― 本地化
- 服务 ―― 邮件
- 服务 ―― 包开发
- 服务 ―― 分页
- 服务 ―― 队列
- 服务 ―― Redis
- 服务 ―― Session
- 服务 ―― Envoy 任务运行器(SSH任务)
- 服务 ―― 任务调度
- 服务 ―― 测试
- 服务 ―― 验证