php - Eloquent 访问器和属性命名

Question

我这样定义我的类:

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Foo extends Model
{
    use HasFactory;

    protected $fillable = [
        'id', 'first_name'
    ];

    public function getFirstNameAttribute($value = null)
    {
        return ucfirst($value);
    }
}

然后我用该模型的条目填充我的数据库:

\App\Models\Foo::create(['first_name' => 'foo']);

然后我调用访问器如下:

\App\Models\Foo::first()->first_name;
=> "Foo"

这是预期的

和

\App\Models\Foo::first()->firstName;
=> ""

这是出乎意料的(但可以理解，因为即使正在调用 getFirstNameAttribute 方法，正在访问数据库属性 firstName 但它并不存在)

我想确保在这两种情况下都访问了正确的属性 (first_name)。

这是否意味着 ($value = null) 不可靠，应该始终依赖 $this->attributes['first_name']？

因此，这段代码变成:

public function getFirstNameAttribute($value = null)
{
    return ucfirst($this->attributes['first_name']);
}

虽然我可能会期待

>>> \App\Models\Foo::first()->first_____na______me;
=> "Foo"

不要这样做。

Answer 1

当您尝试访问模型属性时，Laravel 将 (a) 尝试检索给定的属性，并且 (b) 寻找与您尝试访问的属性匹配的访问器。

然而，约定是数据库字段使用 snake_case 命名和 PHP 函数使用 camelCase 命名(用一只驼峰 Camel )。命名访问器的规则是 get{AttributeName}Attribute 这意味着要查找是否有 first_name 的访问器，Laravel 会将 first_name 转换为StudlyCase(或两个驼峰式 CamelCase 或 PascalCase)并查找名为 getFirstNameAttribute 的函数，然后使用基础数据库值作为参数调用它。无论属性请求被命名为什么，它都将始终这样做。它实际上不必是 snake_case

但是问题是:

1. PHP 函数名不区分大小写。这意味着调用 getFirstNameAttribute 作为 getFirstNaMeAttribute 将工作正常并调用相同的方法
2. FirstName 的访问器将与 first_name 的访问器同名

因此，您的 ->first_na__me 调用将查找访问器 getFirstNaMeAttribute 并且 ->firstName 将执行相同的操作，但只有 first_name 将有一个实际的基础数据库值传递给 $value 参数。

很容易确定访问器 first_name 对应的是什么，但是很难确定 getFirstNameAttribute 对应的数据库值，因为 php 函数名称不区分大小写，所以你可以去一种方式而不是另一种方式。因此，获取文本数据库字段然后调用访问器而不是将访问器与数据库字段相关联会更容易