序列化
序列化
Eloquent: 序列化
簡介
構(gòu)建 JSON API 時，經(jīng)常需要把模型和關(guān)聯(lián)轉(zhuǎn)化為數(shù)組或 JSON。針對這些操作，Eloquent 提供了一些便捷方法，以及對序列化中的屬性控制。
序列化模型 & 集合
序列化為數(shù)組
要轉(zhuǎn)化模型及其加載的 關(guān)聯(lián) 為數(shù)組，可以使用 toArray 方法。這是一個遞歸的方法，因此所有的屬性和關(guān)聯(lián)（包括關(guān)聯(lián)的關(guān)聯(lián)）都將轉(zhuǎn)化成數(shù)組：
$user = App\User::with('roles')->first();return $user->toArray();也可以轉(zhuǎn)化整個模型 集合 為數(shù)組：
$users = App\User::all();return $users->toArray();
序列化為 JSON
方法 toJson 可以把模型轉(zhuǎn)化成 JSON。和方法 toArray 一樣， toJson 方法也是遞歸的，因此所有屬性和關(guān)聯(lián)都會轉(zhuǎn)化成 JSON, 你還可以指定由 PHP 支持的 JSON 編碼選項：
$user = App\User::find(1); return $user->toJson(); return $user->toJson(JSON_PRETTY_PRINT);
也可以把模型或集合轉(zhuǎn)成字符串，方法 toJson 將自動調(diào)用：
$user = App\User::find(1); return (string) $user;
由于模型和集合在轉(zhuǎn)化為字符串的時候會轉(zhuǎn)成 JSON， 因此可以在應用的路由或控制器中直接返回 Eloquent 對象：
Route::get('users', function () {
return App\User::all();
});隱藏 JSON 屬性
有時要將模型數(shù)組或 JSON 中的某些屬性進行隱藏，比如密碼，則可以在模型中添加 $hidden 屬性：
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model{
/**
* 數(shù)組中的屬性會被隱藏。
*
* @var array
*/
protected $hidden = ['password'];
}{note} 隱藏關(guān)聯(lián)時，需使用關(guān)聯(lián)的方法名。
此外，也可以使用屬性 $visible 定義一個模型數(shù)組和 JSON 可見的白名單。轉(zhuǎn)化后的數(shù)組或 JSON 不會出現(xiàn)其他的屬性：
<?phpnamespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model{
/**
* 數(shù)組中的屬性會被展示。
*
* @var array
*/
protected $visible = ['first_name', 'last_name'];
}臨時修改可見屬性
如果需要在一個模型實例中顯示隱藏的屬性，就可以使用 makeVisible 方法。方法 makeVisible 返回模型實例：
return $user->makeVisible('attribute')->toArray();相應地，需要在一個模型實例中隱藏可見的屬性，則可以使用 makeHidden 方法。
return $user->makeHidden('attribute')->toArray();追加 JSON 值
有時，需要在數(shù)組或 JSON 中添加一些數(shù)據(jù)庫沒有字段對應的屬性。 要實現(xiàn)這個功能，先為其定義一個訪問器：
<?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{
/**
* 追加到模型數(shù)組表單的訪問器。
*
* @var array
*/
protected $appends = ['is_admin'];
}使用 append 方法追加屬性后，它將包含在模型的數(shù)組和 JSON 中。 appends 數(shù)組中的屬性也將遵循模型上配置的 visible 和 hidden 設置。
運行時追加
在單個模型實例上，使用方法 append 追加屬性，或者，使用方法 setAppends 重寫整個追加屬性的數(shù)組：
return $user->append('is_admin')->toArray();
return $user->setAppends(['is_admin'])->toArray();序列化日期
自定義任意屬性的日期格式
可以在 Eloquent 的 屬性類型轉(zhuǎn)換 中單獨為日期屬性自定義日期格式：
protected $casts = [ 'birthday' => 'date:Y-m-d', 'joined_at' => 'datetime:Y-m-d H:00', ];
Carbon 全局自定義
Laravel 擴展了 Carbon 日期庫這為 Carbon 的 JSON 序列化提供了便利。要自定義所有 Carbon 日期在整個應用中的序列化，可以使用 Carbon::serializeUsing 方法。方法 serializeUsing 接受一個閉包，該閉包返回一個字符串形式的日期。
<?php
namespace App\Providers;
use Illuminate\Support\Carbon;
use Illuminate\Support\ServiceProvider;
class AppServiceProvider extends ServiceProvider{
/**
* 執(zhí)行注冊后，啟動服務
*
* @return void
*/
public function boot()
{
Carbon::serializeUsing(function ($carbon) {
return $carbon->format('U');
});
}
/**
* 在服務容器中注冊綁定
*
* @return void
*/
public function register()
{
//
}
}