Eloquent：序列化

要转化模型及其加载的 为数组，可以使用 方法。这是一个递归的方法，因此所有的属性和关联（包括关联的关联）都将转化成数组：

也可以转化整个模型集合为数组：

  1. $users = App\User::all();
  3. return $users->toArray();

序列化为 JSON

方法toJson可以把模型转化成 JSON。和方法toArray一样，toJson方法也是递归的，因此所有属性和关联都会转化成 JSON：

  1. $user = App\User::find(1);
  3. return $user->toJson();

也可以把模型或集合转成字符串，方法toJson将自动调用：

  1. $user = App\User::find(1);
  3. return (string) $user;

有时要将模型数组或 JSON 中的某些属性进行隐藏，比如密码，则可以在模型中添加$hidden属性：

  1. <?php
  3. namespace App;
  5. use Illuminate\Database\Eloquent\Model;
  7. class User extends Model
  8. {
  9.     /**
  10.      * 数组中的属性会被隐藏
  11.      *
  12.      * @var array
  13.      */
  14.     protected $hidden = ['password'];
  15. }

此外，也可以使用属性$visible定义一个模型数组和 JSON 可见的白名单。转化后的数组或 JSON 不会出现其他的属性：

  1. <?php
  3. namespace App;
  4. use Illuminate\Database\Eloquent\Model;
  6. class User extends Model
  7. {
  8.     /**
  9.      * 数组中的属性会被展示
  10.      *
  12.      */
  13.     protected $visible = ['first_name', 'last_name'];
  14. }

临时修改可见属性

如果需要在一个模型实例中显示隐藏的属性，就可以使用makeVisible方法。方法makeVisible返回模型实例：

  1. return $user->makeVisible('attribute')->toArray();

相应地, 需要在一个模型实例中隐藏可见的属性，则可以使用makeHidden方法。

  1. <?php
  3. namespace App;
  5. use Illuminate\Database\Eloquent\Model;
  7. class User extends Model
  8. {
  9.     /**
  10.      * 为用户获取管理员标识
  11.      *
  12.      * @return bool
  13.      */
  14.     public function getIsAdminAttribute()
  15.     {
  16.         return $this->attributes['admin'] == 'yes';
  17.     }
  18. }

然后，在模型属性appends中添加该属性名。注意，尽管访问器使用「Camel Case」方式定义，但是属性名通常以「Snake Case」方式引用。

  1. <?php
  3. namespace App;
  5. use Illuminate\Database\Eloquent\Model;
  7. class User extends Model
  8. {
  9.      * 追加到模型数组表单的访问器.
  10.      *
  11.      * @var array
  12.      */
  13.     protected $appends = ['is_admin'];
  14. }

属性只要添加到列表里，就会被包含到模型数组和 JSON 中。appends数组里的属性也会遵循模型配置的visible和hidden。

运行时追加

在单个模型实例上，使用方法append追加属性，或者，使用方法setAppends重写整个追加属性的数组：

  1. return $user->append('is_admin')->toArray();
  3. return $user->setAppends(['is_admin'])->toArray();

自定义任意属性的日期格式

可以在 Eloquent 的中单独为日期属性自定义日期格式：

经由 Carbon 全局自定义

Laravel 扩展了日期库，这为 Carbon 的 JSON 序列化提供了便利。要自定义所有 Carbon 日期在整个应用中的序列化，可以使用Carbon::serializeUsing方法。方法serializeUsing接受一个闭包，该闭包返回一个字符串形式的日期。

  1. <?php
  3. namespace App\Providers;
  5. use Illuminate\Support\Carbon;
  6. use Illuminate\Support\ServiceProvider;
  8. class AppServiceProvider extends ServiceProvider
  9. {
  10.     /**
  11.      * 执行注册后，启动服务.
  12.      *
  13.      * @return void
  14.      */
  15.     public function boot()
  16.     {
  17.         Carbon::serializeUsing(function ($carbon) {
  18.             return $carbon->format('U');
  19.         });
  20.     }
  22.     /**
  23.      * 在服务容器中注册绑定
  24.      *
  25.      * @return void
  26.      */
  27.     public function register()
  28.     {
  29.         //
  30. }

本文章首发在 LearnKu.com 网站上。

本文中的所有译文仅用于学习和交流目的，转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 ，如果我们的工作有侵犯到您的权益，请及时联系我们。