使用 Eloquent 和 Laravel 5 在 json 响应中包含模型关系

Question

我有这样的模型设置：

<?php namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Upload extends Model {

    /**
     * The database table used by the model.
     *
     * @var string
     */
    protected $table = 'uploads';

    /**
     * The attributes excluded from the model's JSON form.
     *
     * @var array
     */
    protected $hidden = array('id', 'user', 'created_at', 'updated_at');

    public function mime() {
        return $this->hasOne('App\Models\Mime', 'mime');
    }
}

当JsonSerialize() 被调用时，它会返回：

{
    "serverPath": "upload/2015/06/06/21/filename.jpg",
    "filename": "filename.jpg",
    "mime": "92"
}

这个92 引用另一个表（App\Models\Mime 代表）中的id，并带有一个与之关联的字符串type。我想用上述字符串替换这个92。

{
    "serverPath": "upload/2015/06/06/21/filename.jpg",
    "filename": "filename.jpg",
    "mime": "image/jpeg"
}

这怎么可能？我在Upload 模型中使用protected $appends 尝试了一些东西，但我不确定我是否完全理解如何在模型中使用/访问关系。

澄清表 mimes 包含列 id 和 type，而表 uploads 包含一个名为 mime 的整数列在 mimes

中引用一个 id

Answer 1

好的，我相信这就是您要找的...

Upload.php（这里没有变化）

<?php namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Upload extends Model {

    /**
     * The database table used by the model.
     *
     * @var string
     */
    protected $table = 'uploads';

    /**
     * The attributes excluded from the model's JSON form.
     *
     * @var array
     */
    protected $hidden = array('id', 'user', 'created_at', 'updated_at');

    public function mime() {
        return $this->hasOne('App\Models\Mime', 'mime');
    }
}

那么你就有了你的 Mime 模型

Mime.php

<?php namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Mime extends Model {

    /**
     * The database table used by the model.
     *
     * @var string
     */
    protected $table = 'mimes';

}

如果你这样做是为了测试，我相信你应该看到类型

routes.php

Route::get('test', function() {
    $upload = \Upload::with('mime')->first();
    // return $upload //here would return it as JSON I'm pretty sure!
    return $upload->mime->type;
});

查看文档以获取有关预加载的更多详细信息：http://laravel.com/docs/5.0/eloquent#eager-loading

Answer 2

将关系命名为与表中的某个字段同名并不是一个好主意。这会在尝试访问关系而不是访问字段时导致问题（正如您所发现的）。

理想情况下，您的mime 字段应重命名为mime_id。这符合 Laravel 的约定，并且是更准确的字段名称。

但是，如果您无法更改字段名称，则应更改关系名称。

class Upload extends Model {
    protected $hidden = array('id', 'user', 'created_at', 'updated_at');

    public function uploadMime() {
        return $this->belongsTo('App\Models\Mime', 'mime');
    }
}

在上面的类中，关系名称现在是uploadMime。此外，关系从hasOne 更改为belongsTo。由于您的 uploads 表具有 mimes 表的外键，因此 Upload 模型属于 Mime 模型（并且 Mime 模型有一个/hasMany Upload 模型）。

现在，您的代码应该如下所示：

$data = \App\Models\Upload::with('uploadMime')->findOrFail(1);
return new JsonResponse($data);

这应该会给你一些类似的输出：

{
    "serverPath": "upload/2015/06/06/21/filename.jpg",
    "filename": "filename.jpg",
    "mime": "92",
    "uploadMime": {
        "id": 92,
        "type": "image/jpeg"
    }
}

使用 $appends 和属性访问器修改 JSON

如果您想更接近您在问题中提供的 JSON 输出，可以创建一个 mimeType 访问器并将其添加到 $appends 属性：

class Upload extends Model {
    // hide the mime field and uploadMime data
    protected $hidden = array('id', 'user', 'created_at', 'updated_at', 'mime', 'uploadMime');

    // add the mimeType attribute to the array
    protected $appends = array('mimeType');

    // code for $this->mimeType attribute
    public function getMimeTypeAttribute($value) {
        $mimeType = null;
        if ($this->uploadMime) {
            $mimeType = $this->uploadMime->type;
        }
        return $mimeType;
    }

    public function uploadMime() {
        return $this->belongsTo('App\Models\Mime', 'mime');
    }
}

这应该会给你一些类似的输出：

{
    "serverPath": "upload/2015/06/06/21/filename.jpg",
    "filename": "filename.jpg",
    "mimeType": "image/jpeg"
}

通过覆盖 toArray() 函数修改 JSON

或者，如果你真的希望JSON使用mime键，你可以直接修改toArray()方法：

class Upload extends Model {
    // hide uploadMime data, but not the mime field
    protected $hidden = array('id', 'user', 'created_at', 'updated_at', 'uploadMime');

    public function uploadMime() {
        return $this->belongsTo('App\Models\Mime', 'mime');
    }

    // override the toArray function (called by toJson)
    public function toArray() {
        // get the original array to be displayed
        $data = parent::toArray();

        // change the value of the 'mime' key
        if ($this->uploadMime) {
            $data['mime'] = $this->uploadMime->type;
        } else {
            $data['mime'] = null;
        }

        return $data;
    }
}

这应该会给你一些类似的输出：

{
    "serverPath": "upload/2015/06/06/21/filename.jpg",
    "filename": "filename.jpg",
    "mime": "image/jpeg"
}