Eloquent: 序列化
介绍
在构建JSON API时，您通常需要将模型和关系转换为数组或JSON。Eloquent提供了方便的方法来进行这些转换，并控制哪些属性包含在序列化中。
序列化模型和集合
序列化为数组
要将模型及其加载的关系转换为数组，您应该使用toArray方法。此方法是递归的，因此所有属性和所有关系（包括关系的关系）都将被转换为数组：
$user = App\User::with('roles')->first();
return $user->toArray();要仅将模型的属性转换为数组，请使用attributesToArray方法：
$user = App\User::first();
return $user->attributesToArray();您还可以将整个集合的模型转换为数组：
$users = App\User::all();
return $users->toArray();序列化为JSON
要将模型转换为JSON，您应该使用toJson方法。与toArray类似，toJson方法是递归的，因此所有属性和关系将被转换为JSON。您还可以指定PHP支持的JSON编码选项支持的PHP：
$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();
});关系
当Eloquent模型被转换为JSON时，其加载的关系将自动作为属性包含在JSON对象中。此外，尽管Eloquent关系方法是使用“驼峰命名法”定义的，但关系的JSON属性将是“蛇形命名法”。
从JSON中隐藏属性
有时您可能希望限制模型的数组或JSON表示中包含的属性，例如密码。为此，请在模型中添加一个$hidden属性：
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
/**
* 应该在数组中隐藏的属性。
*
* @var array
*/
protected $hidden = ['password'];
}NOTE
隐藏关系时，请使用关系的方法名称。
或者，您可以使用visible属性定义一个白名单，列出应该包含在模型的数组和JSON表示中的属性。模型转换为数组或JSON时，所有其他属性将被隐藏：
<?php
namespace 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'];
}一旦属性被添加到appends列表中，它将被包含在模型的数组和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',
];