# 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任務)
- 服務 ―― 任務調度
- 服務 ―― 測試
- 服務 ―― 驗證