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

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

在 Laravel Eloquent 中，你可能会遇到这样的场景：加载模型时的自定义属性。例如，考虑这样的控制器：

<code class="php">public function index()
{
    $sessions = EventSession::all();
    foreach ($sessions as $i =&gt; $session) {
        $sessions[$i]-&gt;available = $session-&gt;getAvailability();
    }
    return $sessions;
}</code>

跳过手动循环并自动填充“可用”属性会很方便。

问题

这里的问题是模型的 toArray() 方法会忽略与基础表中的列不对应的访问器。这是出于性能原因而有意设计的。

解决方案

Laravel 版本 >= 8:

幸运的是，有一种优雅的方法可以使用 Attribute 类来实现此目的：

<code class="php">class EventSession extends Eloquent {

    protected $table = 'sessions';

    public function availability()
    {
        return new Attribute(
            get: fn () =&gt; $this-&gt;calculateAvailability()
        );  
    }
}</code>

Laravel Versions Laravel Versions

Laravel Versions 8:

选项 1：Appends 属性

<code class="php">class EventSession extends Eloquent {

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

    public function getAvailabilityAttribute()
    {
        return $this-&gt;calculateAvailability();  
    }
}</code>

对于小于 8 的版本，可以使用 $appends 属性来控制序列化中包含哪些属性模型的形式：

选项 2：重写 toArray() 方法

<code class="php">class Book extends Eloquent {

    protected $table = 'books';
    
    public function toArray()
    {
        $array = parent::toArray();
        $array['upper'] = $this-&gt;upper;
        return $array;
    }
    
    public function getUpperAttribute()
    {
        return strtoupper($this-&gt;title);    
    }

}</code>

或者，您可以重写 toArray() 方法并手动设置属性：

选项 3：循环遍历变异属性

<code class="php">class Book extends Eloquent {

    protected $table = 'books';
    
    public function toArray()
    {
        $array = parent::toArray();
        foreach ($this-&gt;getMutatedAttributes() as $key)
        {
            if ( ! array_key_exists($key, $array)) {
                $array[$key] = $this-&gt;{$key};   
            }
        }
        return $array;
    }
    
    public function getUpperAttribute()
    {
        return strtoupper($this-&gt;title);    
    }

}</code>

如果您有多个自定义访问器，您可以迭代它们并在序列化期间应用它们：

以上是如何在加载时向 Laravel Eloquent 模型添加自定义属性？的详细内容。更多信息请关注PHP中文网其他相关文章！