PhpStorm 2022.2.2中如何让Laravel模型关联与属性不被识别为魔术方法？

要让IDE识别Laravel模型的关联属性和自定义访问器属性，消除"通过魔术方法访问属性"的警告，需在模型类顶部添加正确的PHPDoc注解，具体方案如下：

1. 关联关系的注解 #

对于hasOne这类关联，Laravel允许通过魔术属性（如$myModel->packages）直接访问关联模型实例。要让IDE识别这个属性，需使用@property-read标签，声明属性的类型和名称：

• @property-read \App\Models\Package|null $packages：表示该属性是只读的，类型为Package模型或null（关联未加载或不存在时）

2. 自定义访问器属性的注解 #

对于通过getQuantityRemainingAttribute定义的自定义属性quantity_remaining，使用@property标签声明属性类型和名称：

• @property int $quantity_remaining：表示该属性可访问，类型为int

完整示例代码 #

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasOne;

/**
 * @property-read Package|null $packages
 * @property int $quantity_remaining
 */
class MyModel extends Model
{
    /**
     * @return HasOne
     */
    public function packages(): HasOne
    {
        return $this->hasOne(Package::class, 'related_id', 'related_id');
    }

    public function getQuantityRemainingAttribute(): int
    {
        // 业务逻辑省略
        return 1;
    }
}

关键说明 #

• @property-read用于关联属性：因为关联属性是Laravel动态生成的只读属性，不能直接赋值，所以用-read后缀
• @property用于自定义访问器属性：如果你的访问器同时定义了对应的setQuantityRemainingAttribute赋值方法，也可以用@property（支持读写）
• 需指定正确的类名（如\App\Models\Package），若已引入命名空间，直接写Package即可，IDE会自动识别

内容的提问来源于stack exchange，提问作者magicianiam