在加载时向 Laravel/Eloquent 模型添加自定义属性？

Question

我希望能够在加载时向 Laravel/Eloquent 模型添加自定义属性/属性，类似于使用RedBean 的$model->open()方法实现的方式。

例如，目前，在我的控制器中，我有：

public function index()
{
    $sessions = EventSession::all();
    foreach ($sessions as $i => $session) {
        $sessions[$i]->available = $session->getAvailability();
    }
    return $sessions;
}

如果能够省略循环并且已经设置并填充了 'available' 属性，那就太好了。

我已经尝试使用文档中描述的一些模型事件在对象加载时附加此属性，但到目前为止没有成功。

笔记：

• 'available' 不是基础表中的字段。
• $sessions作为 API 的一部分作为 JSON 对象返回，因此不能在模板中调用类似$session->available()的内容

Answer 1

该问题是由Model的toArray()方法忽略与基础表中的列不直接相关的任何访问器这一事实引起的。

正如 Taylor Otwell 在这里提到的，“这是有意为之，也是出于性能原因。” 但是，有一种简单的方法可以实现这一目标：

class EventSession extends Eloquent {

    protected $table = 'sessions';
    protected $appends = array('availability');

    public function getAvailabilityAttribute()
    {
        return $this->calculateAvailability();  
    }
}

$appends 属性中列出的任何属性都将自动包含在模型的数组或 JSON 形式中，前提是您已添加适当的访问器。

旧答案（对于 Laravel 版本 < 4.08）：

我发现的最佳解决方案是覆盖toArray()方法并显式设置属性：

class Book extends Eloquent {

    protected $table = 'books';

    public function toArray()
    {
        $array = parent::toArray();
        $array['upper'] = $this->upper;
        return $array;
    }

    public function getUpperAttribute()
    {
        return strtoupper($this->title);    
    }

}

或者，如果您有很多自定义访问器，请遍历它们并应用它们：

class Book extends Eloquent {

    protected $table = 'books';

    public function toArray()
    {
        $array = parent::toArray();
        foreach ($this->getMutatedAttributes() as $key)
        {
            if ( ! array_key_exists($key, $array)) {
                $array[$key] = $this->{$key};   
            }
        }
        return $array;
    }

    public function getUpperAttribute()
    {
        return strtoupper($this->title);    
    }

}

Answer 2

Laravel Eloquent 文档页面上的最后一件事是：

protected $appends = array('is_admin');

这可以自动用于向模型添加新的访问器，而无需任何额外的工作，例如修改::toArray()类的方法。

只需创建getFooBarAttribute(...)访问器并将foo_bar添加到$appends getFooBarAttribute(...)数组。

Answer 3

如果您将getAvailability()方法重命名为getAvailableAttribute()您的方法将成为访问器，您将能够直接在模型上使用->available来读取它。

文档： https : //laravel.com/docs/5.4/eloquent-mutators#accessors-and-mutators

编辑：由于您的属性是“虚拟的”，因此默认情况下它不包含在您的对象的 JSON 表示中。

但我发现了这一点：调用 ->toJson() 时未处理自定义模型访问器？

为了强制您的属性在数组中返回，请将其作为键添加到 $attributes 数组中。

class User extends Eloquent {
    protected $attributes = array(
        'ZipCode' => '',
    );

    public function getZipCodeAttribute()
    {
        return ....
    }
}

我没有测试它，但对于您在当前设置中尝试应该非常简单。

Answer 4

我有一些类似的东西：我的模型中有一个属性图片，它包含文件在 Storage 文件夹中的位置。 图像必须返回 base64 编码

//Add extra attribute
protected $attributes = ['picture_data'];

//Make it available in the json response
protected $appends = ['picture_data'];

//implement the attribute
public function getPictureDataAttribute()
{
    $file = Storage::get($this->picture);
    $type = Storage::mimeType($this->picture);
    return "data:" . $type . ";base64," . base64_encode($file);
}

Answer 5

第 1 步：在$appends定义属性
第 2 步：为该属性定义访问器。
例子：

<?php
...

class Movie extends Model{

    protected $appends = ['cover'];

    //define accessor
    public function getCoverAttribute()
    {
        return json_decode($this->InJson)->cover;
    }

Answer 6

您可以在模型中使用setAttribute函数添加自定义属性

Answer 7

假设您的用户表中有 2 列名为 first_name 和 last_name，并且您想要检索全名。 您可以使用以下代码实现：

class User extends Eloquent {


    public function getFullNameAttribute()
    {
        return $this->first_name.' '.$this->last_name;
    }
}

现在你可以得到全名：

$user = User::find(1);
$user->full_name;

Answer 8

在我的订阅模型中，我需要知道订阅是否暂停。 这是我如何做到的

public function getIsPausedAttribute() {
    $isPaused = false;
    if (!$this->is_active) {
        $isPaused = true;
    }
}

然后在视图模板中，我可以使用$subscription->is_paused来获得结果。

getIsPausedAttribute是设置自定义属性的格式，

并使用is_paused在您的视图中获取或使用该属性。

Answer 9

就我而言，创建一个空列并设置其访问器工作正常。 我的访问器从 dob 列填充用户的年龄。 toArray() 函数也有效。

public function getAgeAttribute()
{
  return Carbon::createFromFormat('Y-m-d', $this->attributes['dateofbirth'])->age;
}