序列化
序列化模型& 集合
簡介建構JSON API 時,常常需要把模型和關聯轉換為陣列或JSON。針對這些操作,Eloquent 提供了一些便捷方法,以及對序列化中的屬性控制。 ###################################序列化為數組
要轉換模型及其載入的 關聯 為數組,可以使用 toArray
方法。這是一個遞歸的方法,因此所有的屬性和關聯(包括關聯的關聯)都會轉換成陣列:
$user = App\User::with('roles')->first();return $user->toArray();
也可以轉換整個模型集合為陣列:
$users = App\User::all();return $users->toArray();
#序列化為JSON
方法toJson
可以把模型轉換成JSON。和方法toArray
一樣, toJson
方法也是遞歸的,因此所有屬性和關聯都會轉換成JSON, 你還可以指定由PHP 支援的JSON 編碼選項 :
$user = App\User::find(1); return $user->toJson(); return $user->toJson(JSON_PRETTY_PRINT);
也可以把模型或集合轉成字串,方法toJson
會自動呼叫:
$user = App\User::find(1); return (string) $user;
由於模型和集合在轉換為字串的時候會轉換成JSON, 因此可以在應用的路由或控制器中直接傳回Eloquent 物件:
Route::get('users', function () { return App\User::all(); });##隱藏JSON 屬性
有時要將模型陣列或JSON 中的某些屬性隱藏,例如密碼,則可以在模型中加入
$hidden 屬性:
<?php namespace App; use Illuminate\Database\Eloquent\Model; class User extends Model{ /** * 数组中的属性会被隐藏。 * * @var array */ protected $hidden = ['password']; }
{note}隱藏關聯時,需使用關聯的方法名稱。此外,也可以使用屬性
$visible 定義一個模型陣列和 JSON 可見的白名單。轉換後的陣列或JSON 不會出現其他的屬性:
<?phpnamespace App; use Illuminate\Database\Eloquent\Model; class User extends Model{ /** * 数组中的属性会被展示。 * * @var array */ protected $visible = ['first_name', 'last_name']; }暫時修改可見屬性如果需要在一個模型實例中顯示隱藏的屬性,就可以使用
makeVisible 方法。方法
makeVisible 傳回模型實例:
return $user->makeVisible('attribute')->toArray();對應地,需要在一個模型實例中隱藏可見的屬性,則可以使用
makeHidden 方法。
return $user->makeHidden('attribute')->toArray();追加JSON 值有時,需要在陣列或JSON 中加入一些資料庫沒有欄位對應的屬性。要實現這個功能,先為其定義一個存取器:
<?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']; }使用
append 方法追加屬性後,它將包含在模型的陣列和 JSON 中。
appends 陣列中的屬性也會遵循模型上配置的
visible 和
hidden 設定。
append 追加屬性,或者,使用方法
setAppends重寫整個追加屬性的陣列:
return $user->append('is_admin')->toArray(); return $user->setAppends(['is_admin'])->toArray();
#
序列化日期
自訂任意屬性的日期格式
#可以在Eloquent 的屬性類型轉換中單獨為日期屬性自訂日期格式:
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{ /** * 执行注册后,启动服务 * * @return void */ public function boot() { Carbon::serializeUsing(function ($carbon) { return $carbon->format('U'); }); } /** * 在服务容器中注册绑定 * * @return void */ public function register() { // } }