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

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

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

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

能够省略该循环并已设置并填充了“ available”属性将是很好的选择。

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

笔记：

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

问题是由Model的toArray()方法忽略所有与基础表中的列不直接相关的访问器而导致的。

正如泰勒·奥特威尔（Taylor Otwell）在这里提到的：“这是故意的，并且出于性能考虑。” 但是，有一种简单的方法可以实现此目的：

class EventSession extends Eloquent {

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

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

如果您添加了适当的访问器，则$ appends属性中列出的所有属性将自动包含在模型的数组或JSON形式中。

旧答案（适用于<4.08的Laravel版本）：

我发现的最佳解决方案是重写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);    
    }

}

在该Laravel雄辩文档页面上最后一件事是：

protected $appends = array('is_admin');

它可以自动用于向模型中添加新的访问器，而无需进行诸如修改方法之类的任何其他工作::toArray()。

只需创建getFooBarAttribute(...)访问器，然后将foo_barto 添加到 $appends数组即可。

如果将您的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 ....
    }
}

我没有进行测试，但是对于您在当前设置中尝试来说应该是微不足道的。

我有一个类似的东西：我的模型中有一个属性图片，其中包含文件在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);
}

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

假设您的用户表中有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;

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

<?php
...

class Movie extends Model{

    protected $appends = ['cover'];

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

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

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

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

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

并用于is_paused获取或使用视图中的属性。

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

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